fix(java/pom): ignore unsupported requirements (#1514)

Co-authored-by: Andrey Levchenko <levchenko.andrey@gmail.com>

.github/dependabot.yml

@@ -0,0 +1,10 @@
+version: 2
+updates:
+- package-ecosystem: github-actions
+  directory: /
+  schedule:
+    interval: daily
+- package-ecosystem: docker
+  directory: /
+  schedule:
+    interval: daily

.github/workflows/mkdocs-latest.yaml

@@ -1,5 +1,10 @@
 name: Deploy the latest documentation
 on:
+  workflow_dispatch:
+    inputs:
+      version:
+        description: Version to be deployed
+        required: true
   push:
     tags:
       - "v*"
@@ -27,7 +32,11 @@ jobs:
         run: |
           git config user.name "knqyf263"
           git config user.email "knqyf263@gmail.com"
-      - name: Deploy the latest documents
+      - name: Deploy the latest documents from new tag push
+        if: ${{ github.event.inputs.version == '' }}
         run: |
           VERSION=$(echo ${{ github.ref }} | sed -e "s#refs/tags/##g")
           mike deploy --push --update-aliases $VERSION latest
+      - name: Deploy the latest documents from manual trigger
+        if: ${{ github.event.inputs.version != '' }}
+        run: mike deploy --push --update-aliases ${{ github.event.inputs.version }} latest

.github/workflows/publish-chart.yaml

@@ -1,47 +1,84 @@
-name: Publish Chart Helm
+
+name: Publish Helm chart
+
 on:
+  workflow_dispatch:
+  pull_request:
+    branches:
+      - main
+    paths:
+      - 'helm/trivy/**'
   push:
     branches: [main]
     paths:
       - 'helm/trivy/**'
-  workflow_dispatch:
 env:
   HELM_REP: helm-charts
   GH_OWNER: aquasecurity
   CHART_DIR: helm/trivy
+  KIND_VERSION: "v0.11.1"
+  KIND_IMAGE: "kindest/node:v1.21.1@sha256:69860bda5563ac81e3c0057d654b5253219618a22ec3a346306239bba8cfa1a6"
 jobs:
-  release:
+  test-chart:
     runs-on: ubuntu-20.04
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@ec3a7ce113134d7a93b817d10a8272cb61118579 #v2.4.0
         with:
           fetch-depth: 0
       - name: Install Helm
-        uses: azure/setup-helm@v1
+        uses: azure/setup-helm@18bc76811624f360dbd7f18c2d4ecb32c7b87bab #v1.1
         with:
           version: v3.5.0
+      - name: Set up python
+        uses: actions/setup-python@0066b88440aa9562be742e2c60ee750fc57d8849 #v2.3.0
+        with:
+          python-version: 3.7
+      - name: Setup Chart Linting
+        id: lint
+        uses: helm/chart-testing-action@5f16c27cf7a4fa9c776ff73734df3909b2b65127 #v2.1.0
+      - name: Setup Kubernetes cluster (KIND)
+        uses: helm/kind-action@94729529f85113b88f4f819c17ce61382e6d8478 #v1.2.0
+        with:
+          version: ${{ env.KIND_VERSION }}
+          image: ${{ env.KIND_IMAGE }}
+      - name: Run chart-testing
+        run: ct lint-and-install --validate-maintainers=false --charts helm/trivy
+      - name: Run chart-testing (Ingress enabled)
+        run: |
+          sed -i -e '97s,false,'true',g' ./helm/trivy/values.yaml
+          ct lint-and-install --validate-maintainers=false --charts helm/trivy
+
+  publish-chart:
+    if: github.event_name == 'push'
+    needs:
+      - test-chart
+    runs-on: ubuntu-20.04
+    steps:
+      - name: Checkout
+        uses: actions/checkout@ec3a7ce113134d7a93b817d10a8272cb61118579 #v2.4.0
+        with:
+          fetch-depth: 0
       - name: Install chart-releaser
         run: |
-          wget https://github.com/helm/chart-releaser/releases/download/v1.1.1/chart-releaser_1.1.1_linux_amd64.tar.gz
-          tar xzvf chart-releaser_1.1.1_linux_amd64.tar.gz cr
+          wget https://github.com/helm/chart-releaser/releases/download/v1.3.0/chart-releaser_1.3.0_linux_amd64.tar.gz
+          echo "baed2315a9bb799efb71d512c5198a2a3b8dcd139d7f22f878777cffcd649a37  chart-releaser_1.3.0_linux_amd64.tar.gz" | sha256sum -c -
+          tar xzvf chart-releaser_1.3.0_linux_amd64.tar.gz cr
       - name: Package helm chart
         run: |
           ./cr package ${{ env.CHART_DIR }}
       - name: Upload helm chart
         # Failed with upload the same version: https://github.com/helm/chart-releaser/issues/101
         continue-on-error: true
-        ## Upload the tar in the Releases repository
         run: |
-          ./cr upload -o ${{ env.GH_OWNER }} -r ${{ env.HELM_REP }} --token ${{ secrets.ORG_GITHUB_TOKEN }} -p .cr-release-packages
+          ./cr upload -o ${{ env.GH_OWNER }} -r ${{ env.HELM_REP }} --token ${{ secrets.ORG_REPO_TOKEN }} -p .cr-release-packages
       - name: Index helm chart
         run: |
           ./cr index -o ${{ env.GH_OWNER }} -r ${{ env.HELM_REP }} -c https://${{ env.GH_OWNER }}.github.io/${{ env.HELM_REP }}/ -i index.yaml
-
       - name: Push index file
-        uses: dmnemec/copy_file_to_another_repo_action@v1.0.4
+        uses: dmnemec/copy_file_to_another_repo_action@c93037aa10fa8893de271f19978c980d0c1a9b37 #v1.1.1
         env:
-          API_TOKEN_GITHUB: ${{ secrets.ORG_GITHUB_TOKEN }}
+          API_TOKEN_GITHUB: ${{ secrets.ORG_REPO_TOKEN }}
         with:
           source_file: 'index.yaml'
           destination_repo: '${{ env.GH_OWNER }}/${{ env.HELM_REP }}'

.github/workflows/release.yaml

@@ -4,7 +4,7 @@ on:
     tags:
       - "v*"
 env:
-  GO_VERSION: "1.16"
+  GO_VERSION: "1.17"
   GH_USER: "aqua-bot"
 jobs:
   release:
@@ -49,27 +49,32 @@ jobs:
         with:
           registry: ghcr.io
           username: ${{ env.GH_USER }}
-          password: ${{ secrets.ORG_GITHUB_TOKEN }}
+          password: ${{ secrets.GITHUB_TOKEN }}
       - name: Login to ECR
         uses: docker/login-action@v1
         with:
           registry: public.ecr.aws
           username: ${{ secrets.ECR_ACCESS_KEY_ID }}
           password: ${{ secrets.ECR_SECRET_ACCESS_KEY }}
+      - name: Generate SBOM
+        uses: CycloneDX/gh-gomod-generate-sbom@v1
+        with:
+          args: mod -licenses -json -output bom.json
+          version: ^v1
       - name: Release
         uses: goreleaser/goreleaser-action@v2
         with:
-          version: v0.164.0
+          version: v0.183.0
           args: release --rm-dist
         env:
-          GITHUB_TOKEN: ${{ secrets.ORG_GITHUB_TOKEN }}
+          GITHUB_TOKEN: ${{ secrets.ORG_REPO_TOKEN }}
       - name: Checkout trivy-repo
         uses: actions/checkout@v2
         with:
           repository: ${{ github.repository_owner }}/trivy-repo
           path: trivy-repo
           fetch-depth: 0
-          token: ${{ secrets.ORG_GITHUB_TOKEN }}
+          token: ${{ secrets.ORG_REPO_TOKEN }}
       - name: Setup git settings
         run: |
           git config --global user.email "knqyf263@gmail.com"

.github/workflows/scan.yaml

@@ -0,0 +1,25 @@
+name: Scan
+on: [push, pull_request]
+jobs:
+  build:
+    name: Scan Go vulnerabilities
+    runs-on: ubuntu-18.04
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+
+      - name: Run Trivy vulnerability scanner to scan for Critical Vulnerabilities
+        uses: aquasecurity/trivy-action@master
+        with:
+          scan-type: 'fs'
+          exit-code: '1'
+          severity: 'CRITICAL'
+          skip-dirs: integration
+
+      - name: Run Trivy vulnerability scanner to scan for Medium and High Vulnerabilities
+        uses: aquasecurity/trivy-action@master
+        with:
+          scan-type: 'fs'
+          exit-code: '0'
+          severity: 'HIGH,MEDIUM'
+          skip-dirs: integration

.github/workflows/stale-issues.yaml

@@ -7,7 +7,7 @@ jobs:
     timeout-minutes: 1
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/stale@v3
+    - uses: actions/stale@v4
       with:
         repo-token: ${{ secrets.GITHUB_TOKEN }}
         stale-issue-message: 'This issue is stale because it has been labeled with inactivity.'

.github/workflows/test.yaml

@@ -1,7 +1,16 @@
 name: Test
-on: pull_request
+on:
+  push:
+    branches:
+      - main
+    paths-ignore:
+      - '*.md'
+      - 'docs/**'
+      - 'mkdocs.yml'
+      - 'LICENSE'
+  pull_request:
 env:
-  GO_VERSION: "1.16"
+  GO_VERSION: "1.17"
 jobs:
   test:
     name: Test
@@ -17,17 +26,12 @@ jobs:
       - name: Lint
         uses: golangci/golangci-lint-action@v2
         with:
-          version: v1.31
+          version: v1.41
           args: --deadline=30m
 
       - name: Run unit tests
         run: make test
 
-      - name: Upload code coverage
-        uses: codecov/codecov-action@v1
-        with:
-          files: ./coverage.txt
-
   integration:
     name: Integration Test
     runs-on: ubuntu-latest
@@ -71,7 +75,7 @@ jobs:
     - name: Run GoReleaser
       uses: goreleaser/goreleaser-action@v2
       with:
-        version: v0.164.0
+        version: v0.183.0
         args: release --snapshot --rm-dist --skip-publish
 
   build-documents:

.gitignore

@@ -23,4 +23,10 @@ thumbs.db
 
 # test fixtures
 coverage.txt
-integration/testdata/fixtures/
+integration/testdata/fixtures/images
+
+# SBOMs generated during CI
+/bom.json
+
+# goreleaser output
+dist

.golangci.yaml

@@ -6,12 +6,10 @@ linters-settings:
     check-shadowing: false
   gofmt:
     simplify: false
-  golint:
-    min-confidence: 0
+  revive:
+    ignore-generated-header: true
   gocyclo:
     min-complexity: 10
-  maligned:
-    suggest-new: true
   dupl:
     threshold: 100
   goconst:
@@ -32,14 +30,13 @@ linters:
     - errcheck
     - varcheck
     - deadcode
-    - golint
+    - revive
     - gosec
     - unconvert
     - goconst
     - gocyclo
     - gofmt
     - goimports
-    - maligned
     - misspell
 
 run:

CONTRIBUTING.md

@@ -1,9 +1,9 @@
-Thank you for taking interest in contributing to Trivy !
+Thank you for taking interest in contributing to Trivy!
 
 ## Issues
 - Feel free to open issues for any reason. When you open a new issue, you'll have to select an issue kind: bug/feature/support and fill the required information based on the selected template.
 - Please spend a small amount of time giving due diligence to the issue tracker. Your issue might be a duplicate. If it is, please add your comment to the existing issue.
-- Remember users might be searching for your issue in the future, so please give it a meaningful title to help others.
+- Remember that users might search for your issue in the future, so please give it a meaningful title to help others.
 - The issue should clearly explain the reason for opening, the proposal if you have any, and any relevant technical information.
 
 ## Pull Requests
@@ -23,6 +23,6 @@ Thank you for taking interest in contributing to Trivy !
 Trivy is composed of several different repositories that work together:
 
 - [Trivy](https://github.com/aquasecurity/trivy) is the client-side, user-facing, command line tool.
-- [vuln-list](https://github.com/aquasecurity/vuln-list) is a vulnerabilities database, aggregated from different sources, and normalized for easy consumption. This of this as the "server" side of the trivy command line tool. **There should be no pull requests to this repo** 
+- [vuln-list](https://github.com/aquasecurity/vuln-list) is a vulnerabilities database, aggregated from different sources, and normalized for easy consumption. Think of this as the "server" side of the trivy command line tool. **There should be no pull requests to this repo** 
 - [vuln-list-update](https://github.com/aquasecurity/vuln-list-update) is the code that maintains the vuln-list database.
-- [fanal](https://github.com/aquasecurity/fanal) is a library for extracting system information containers. It is being used by Trivy to find testable subjects in the container image.
+- [fanal](https://github.com/aquasecurity/fanal) is a library for extracting system information from containers. It is being used by Trivy to find testable subjects in the container image.

Dockerfile

@@ -1,4 +1,4 @@
-FROM alpine:3.12
+FROM alpine:3.15.0
 RUN apk --no-cache add ca-certificates git
 COPY trivy /usr/local/bin/trivy
 COPY contrib/*.tpl contrib/

Makefile

@@ -15,7 +15,7 @@ $(GOBIN)/wire:
 
 .PHONY: wire
 wire: $(GOBIN)/wire
-	wire gen ./pkg/... ./internal/...
+	wire gen ./pkg/...
 
 .PHONY: mock
 mock: $(GOBIN)/mockery
@@ -27,22 +27,22 @@ deps:
 	go mod tidy
 
 $(GOBIN)/golangci-lint:
-	curl -sfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh| sh -s -- -b $(GOBIN) v1.21.0
+	curl -sfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh| sh -s -- -b $(GOBIN) v1.41.1
 
 .PHONY: test
 test:
 	go test -v -short -coverprofile=coverage.txt -covermode=atomic ./...
 
-integration/testdata/fixtures/*.tar.gz:
-	git clone https://github.com/aquasecurity/trivy-test-images.git integration/testdata/fixtures
+integration/testdata/fixtures/images/*.tar.gz:
+	git clone https://github.com/aquasecurity/trivy-test-images.git integration/testdata/fixtures/images
 
 .PHONY: test-integration
-test-integration: integration/testdata/fixtures/*.tar.gz
+test-integration: integration/testdata/fixtures/images/*.tar.gz
 	go test -v -tags=integration ./integration/...
 
 .PHONY: lint
 lint: $(GOBIN)/golangci-lint
-	$(GOBIN)/golangci-lint run
+	$(GOBIN)/golangci-lint run --timeout 5m
 
 .PHONY: fmt
 fmt:
@@ -54,7 +54,7 @@ build:
 
 .PHONY: protoc
 protoc:
-	find ./rpc/ -name "*.proto" -type f -exec protoc --proto_path=$(GOSRC):. --twirp_out=. --go_out=. {} \;
+	find ./rpc/ -name "*.proto" -type f -exec protoc --proto_path=$(GOSRC):. --twirp_out=. --twirp_opt=paths=source_relative --go_out=. --go_opt=paths=source_relative {} \;
 
 .PHONY: install
 install:
@@ -62,10 +62,10 @@ install:
 
 .PHONY: clean
 clean:
-	rm -rf integration/testdata/fixtures/
+	rm -rf integration/testdata/fixtures/images
 
 $(GOBIN)/labeler:
-	GO111MODULE=off go get github.com/knqyf263/labeler
+	go install github.com/knqyf263/labeler@latest
 
 .PHONY: label
 label: $(GOBIN)/labeler

README.md

@@ -1,89 +1,45 @@
-<img src="docs/imgs/logo.png" width="150">
+<p align="center">
+  <img src="docs/imgs/logo.png" width="200">
+</p>
 
+<p align="center">
+  <a href="https://aquasecurity.github.io/trivy/">Documentation</a> 
+</p>
+
+<p align="center">
+Scanner for vulnerabilities in container images, file systems, and Git repositories, as well as for configuration issues
+</p>
 
 [![GitHub Release][release-img]][release]
-[![Go Report Card](https://goreportcard.com/badge/github.com/aquasecurity/trivy)](https://goreportcard.com/report/github.com/aquasecurity/trivy)
-[![License: Apache-2.0](https://img.shields.io/badge/License-Apache%202.0-blue.svg)][license]
-[![codecov](https://codecov.io/gh/aquasecurity/trivy/branch/main/graph/badge.svg)](https://codecov.io/gh/aquasecurity/trivy)
+[![Test][test-img]][test]
+[![Go Report Card][go-report-img]][go-report]
+[![License: Apache-2.0][license-img]][license]
 [![GitHub All Releases][github-all-releases-img]][release]
 ![Docker Pulls][docker-pulls]
 
-[release]: https://github.com/aquasecurity/trivy/releases
-[release-img]: https://img.shields.io/github/release/aquasecurity/trivy.svg?logo=github
-[github-all-releases-img]: https://img.shields.io/github/downloads/aquasecurity/trivy/total?logo=github
-[docker-pulls]: https://img.shields.io/docker/pulls/aquasec/trivy?logo=docker&label=docker%20pulls%20%2F%20trivy
-[license]: https://github.com/aquasecurity/trivy/blob/main/LICENSE
-
-
-A Simple and Comprehensive Vulnerability Scanner for Containers and other Artifacts, Suitable for CI.
 
 # Abstract
-`Trivy` (`tri` pronounced like **tri**gger, `vy` pronounced like en**vy**) is a simple and comprehensive vulnerability scanner for containers and other artifacts.
-A software vulnerability is a glitch, flaw, or weakness present in the software or in an Operating System.
-`Trivy` detects vulnerabilities of OS packages (Alpine, RHEL, CentOS, etc.) and application dependencies (Bundler, Composer, npm, yarn, etc.).
-`Trivy` is easy to use. Just install the binary and you're ready to scan. All you need to do for scanning is to specify a target such as an image name of the container.
+`Trivy` (`tri` pronounced like **tri**gger, `vy` pronounced like en**vy**) is a simple and comprehensive scanner for vulnerabilities in container images, file systems, and Git repositories, as well as for configuration issues.
+`Trivy` detects vulnerabilities of OS packages (Alpine, RHEL, CentOS, etc.) and language-specific packages (Bundler, Composer, npm, yarn, etc.).
+In addition, `Trivy` scans Infrastructure as Code (IaC) files such as Terraform, Dockerfile and Kubernetes, to detect potential configuration issues that expose your deployments to the risk of attack.
+`Trivy` is easy to use. Just install the binary and you're ready to scan.
 
-<img src="docs/imgs/overview.png" width="700">
+<p align="center">
+  <img src="docs/imgs/overview.png" width="800" alt="Trivy Overview">
+</p>
 
-Trivy can be run in two different modes:
-
-- [Standalone](https://aquasecurity.github.io/trivy/latest/modes/standalone/)
-- [Client/Server](https://aquasecurity.github.io/trivy/latest/modes/client-server/)
-
-Trivy can scan three different artifacts:
-
-- [Container Images](https://aquasecurity.github.io/trivy/latest/scanning/image/)
-- [Filesystem](https://aquasecurity.github.io/trivy/latest/scanning/filesystem/)
-- [Git Repositories](https://aquasecurity.github.io/trivy/latest/scanning/git-repository/)
-
-<img src="docs/imgs/usage.gif" width="700">
-<img src="docs/imgs/usage1.png" width="600">
-<img src="docs/imgs/usage2.png" width="600">
-
-It is considered to be used in CI. Before pushing to a container registry or deploying your application, you can scan your local container image and other artifacts easily.
-See [here](https://aquasecurity.github.io/trivy/latest/integrations/) for details.
-
-# Features
-
-- Detect comprehensive vulnerabilities
-  - OS packages (Alpine, **Red Hat Universal Base Image**, Red Hat Enterprise Linux, CentOS, Oracle Linux, Debian, Ubuntu, Amazon Linux, openSUSE Leap, SUSE Enterprise Linux, Photon OS and Distroless)
-  - **Application dependencies** (Bundler, Composer, Pipenv, Poetry, npm, yarn, Cargo, NuGet, Maven, and Go)
-- Simple
-  - Specify only an image name or artifact name
-  - See [Quick Start](#quick-start) and [Examples](#examples)
-- Fast
-  - The first scan will finish within 10 seconds (depending on your network). Consequent scans will finish in single seconds.
-  - Unlike other scanners that take long to fetch vulnerability information (~10 minutes) on the first run, and encourage you to maintain a durable vulnerability database, Trivy is stateless and requires no maintenance or preparation.
-- Easy installation
-  - `apt-get install`, `yum install` and `brew install` is possible (See [Installation](#installation))
-  - **No pre-requisites** such as installation of DB, libraries, etc.
-- High accuracy
-  - **Especially Alpine Linux and RHEL/CentOS**
-  - Other OSes are also high
-- DevSecOps
-  - **Suitable for CI** such as Travis CI, CircleCI, Jenkins, GitLab CI, etc.
-  - See [CI Example](#continuous-integration-ci)
-- Support multiple formats
-  - container image
-    - A local image in Docker Engine which is running as a daemon
-    - A local image in Podman (>=2.0) which is exposing a socket
-    - A remote image in Docker Registry such as Docker Hub, ECR, GCR and ACR
-    - A tar archive stored in the `docker save` / `podman save` formatted file
-    - An image directory compliant with [OCI Image Format](https://github.com/opencontainers/image-spec)
-  - local filesystem
-  - remote git repository
-
-Please see [LICENSE][license] for Trivy licensing information. Note that Trivy uses vulnerability information from a variety of sources, some of which are licensed for non-commercial use only.
-
-# Documentation
-The official documentation, which provides detailed installation, configuration, and quick start guides, is available at https://aquasecurity.github.io/trivy/.
-
-# Installation
-See [here](https://aquasecurity.github.io/trivy/latest/installation/)
+### Demo: Vulnerability Detection (Container Image)
+<p align="center">
+  <img src="docs/imgs/vuln-demo.gif" width="1000" alt="Vulnerability Detection">
+</p>
 
+### Demo: Misconfiguration Detection (IaC Files)
+<p align="center">
+  <img src="docs/imgs/misconf-demo.gif" width="1000" alt="Misconfiguration Detection">
+</p>
 
 # Quick Start
-
+## Scan Image for Vulnerabilities
 Simply specify an image name (and a tag).
 
 ```
@@ -114,21 +70,150 @@ Total: 1 (UNKNOWN: 0, LOW: 0, MEDIUM: 1, HIGH: 0, CRITICAL: 0)
 |         |                  |          |                   |               | with long nonces               |
 +---------+------------------+----------+-------------------+---------------+--------------------------------+
 ```
+</details>
+
+## Scan Filesystem for Vulnerabilities and Misconfigurations
+Simply specify a directory to scan.
+
+```bash
+$ trivy fs --security-checks vuln,config [YOUR_PROJECT_DIR]
+```
+
+For example:
+
+```bash
+$ trivy fs --security-checks vuln,config myproject/
+```
+
+<details>
+<summary>Result</summary>
+
+```bash
+2021-07-09T12:03:27.564+0300    INFO    Number of language-specific files: 1
+2021-07-09T12:03:27.564+0300    INFO    Detecting pipenv vulnerabilities...
+2021-07-09T12:03:27.566+0300    INFO    Detected config files: 1
+
+Pipfile.lock (pipenv)
+=====================
+Total: 1 (HIGH: 1, CRITICAL: 0)
+
++----------+------------------+----------+-------------------+---------------+---------------------------------------+
+| LIBRARY  | VULNERABILITY ID | SEVERITY | INSTALLED VERSION | FIXED VERSION |                 TITLE                 |
++----------+------------------+----------+-------------------+---------------+---------------------------------------+
+| httplib2 | CVE-2021-21240   | HIGH     | 0.12.1            | 0.19.0        | python-httplib2: Regular              |
+|          |                  |          |                   |               | expression denial of                  |
+|          |                  |          |                   |               | service via malicious header          |
+|          |                  |          |                   |               | -->avd.aquasec.com/nvd/cve-2021-21240 |
++----------+------------------+----------+-------------------+---------------+---------------------------------------+
+
+Dockerfile (dockerfile)
+=======================
+Tests: 23 (SUCCESSES: 22, FAILURES: 1, EXCEPTIONS: 0)
+Failures: 1 (HIGH: 1, CRITICAL: 0)
+
++---------------------------+------------+----------------------+----------+------------------------------------------+
+|           TYPE            | MISCONF ID |        CHECK         | SEVERITY |                 MESSAGE                  |
++---------------------------+------------+----------------------+----------+------------------------------------------+
+| Dockerfile Security Check |   DS002    | Image user is 'root' |   HIGH   | Last USER command in                     |
+|                           |            |                      |          | Dockerfile should not be 'root'          |
+|                           |            |                      |          | -->avd.aquasec.com/appshield/ds002       |
++---------------------------+------------+----------------------+----------+------------------------------------------+
+```
+</details>
+
+## Scan Directory for Misconfigurations
+
+Simply specify a directory containing IaC files such as Terraform and Dockerfile.
+
+```
+$ trivy config [YOUR_IAC_DIR]
+```
+
+For example:
+
+```
+$ ls build/
+Dockerfile
+$ trivy config ./build
+```
+
+<details>
+<summary>Result</summary>
+
+```
+2021-07-09T10:06:29.188+0300    INFO    Need to update the built-in policies
+2021-07-09T10:06:29.188+0300    INFO    Downloading the built-in policies...
+2021-07-09T10:06:30.520+0300    INFO    Detected config files: 1
+
+Dockerfile (dockerfile)
+=======================
+Tests: 23 (SUCCESSES: 22, FAILURES: 1, EXCEPTIONS: 0)
+Failures: 1 (UNKNOWN: 0, LOW: 0, MEDIUM: 0, HIGH: 1, CRITICAL: 0)
+
++---------------------------+------------+----------------------+----------+------------------------------------------+
+|           TYPE            | MISCONF ID |        CHECK         | SEVERITY |                 MESSAGE                  |
++---------------------------+------------+----------------------+----------+------------------------------------------+
+| Dockerfile Security Check |   DS002    | Image user is 'root' |   HIGH   | Last USER command in                     |
+|                           |            |                      |          | Dockerfile should not be 'root'          |
+|                           |            |                      |          | -->avd.aquasec.com/appshield/ds002       |
++---------------------------+------------+----------------------+----------+------------------------------------------+
+```
 
 </details>
 
-# Examples
-See [here](https://aquasecurity.github.io/trivy/latest/examples/filter/)
 
-# Continuous Integration (CI)
-See [here](https://aquasecurity.github.io/trivy/latest/integrations/)
+# Features
 
-# Vulnerability Detection
-See [here](https://aquasecurity.github.io/trivy/latest/vuln-detection/)
+- Comprehensive vulnerability detection
+  - OS packages (Alpine Linux, Red Hat Universal Base Image, Red Hat Enterprise Linux, CentOS, Oracle Linux, Debian, Ubuntu, Amazon Linux, openSUSE Leap, SUSE Enterprise Linux, Photon OS and Distroless)
+  - **Language-specific packages** (Bundler, Composer, Pipenv, Poetry, npm, yarn, Cargo, NuGet, Maven, and Go)
+- Misconfiguration detection (IaC scanning) 
+  - A wide variety of built-in policies are provided **out of the box**
+    - Kubernetes, Docker, Terraform, and more coming soon
+  - Support custom policies
+- Simple
+  - Specify only an image name, a path to config files, or an artifact name
+- Fast
+  - The first scan will finish within 10 seconds (depending on your network). Consequent scans will finish in single seconds.
+- Easy installation
+  - `apt-get install`, `yum install` and `brew install` are possible.
+  - **No pre-requisites** such as installation of DB, libraries, etc.
+- High accuracy
+  - **Especially [Alpine Linux][alpine] and RHEL/CentOS**
+  - Other OSes are also high
+- DevSecOps
+  - **Suitable for CI** such as GitHub Actions, Jenkins, GitLab CI, etc.
+- Support multiple targets
+  - container image, local filesystem and remote git repository
 
-# Usage
-See [here](https://aquasecurity.github.io/trivy/latest/usage/)
+# Integrations
+- [GitHub Actions][action]
+- [Visual Studio Code][vscode]
 
-# Author
+# Documentation
+The official documentation, which provides detailed installation, configuration, and quick start guides, is available at https://aquasecurity.github.io/trivy/.
 
-[Teppei Fukuda](https://github.com/knqyf263) (knqyf263)
+---
+
+Trivy is an [Aqua Security][aquasec] open source project.  
+Learn about our open source work and portfolio [here][oss].  
+Contact us about any matter by opening a GitHub Discussion [here][discussions]
+
+[test]: https://github.com/aquasecurity/trivy/actions/workflows/test.yaml
+[test-img]: https://github.com/aquasecurity/trivy/actions/workflows/test.yaml/badge.svg
+[go-report]: https://goreportcard.com/report/github.com/aquasecurity/trivy
+[go-report-img]: https://goreportcard.com/badge/github.com/aquasecurity/trivy
+[release]: https://github.com/aquasecurity/trivy/releases
+[release-img]: https://img.shields.io/github/release/aquasecurity/trivy.svg?logo=github
+[github-all-releases-img]: https://img.shields.io/github/downloads/aquasecurity/trivy/total?logo=github
+[docker-pulls]: https://img.shields.io/docker/pulls/aquasec/trivy?logo=docker&label=docker%20pulls%20%2F%20trivy
+[license]: https://github.com/aquasecurity/trivy/blob/main/LICENSE
+[license-img]: https://img.shields.io/badge/License-Apache%202.0-blue.svg
+
+[alpine]: https://ariadne.space/2021/06/08/the-vulnerability-remediation-lifecycle-of-alpine-containers/
+[action]: https://github.com/aquasecurity/trivy-action
+[vscode]: https://github.com/aquasecurity/trivy-vscode-extension
+
+[aquasec]: https://aquasec.com
+[oss]: https://www.aquasec.com/products/open-source-projects/
+[discussions]: https://github.com/aquasecurity/trivy/discussions

ci/deploy-deb.sh

@@ -1,7 +1,7 @@
 #!/bin/bash
 
 DEBIAN_RELEASES=$(debian-distro-info --supported)
-UBUNTU_RELEASES=$(ubuntu-distro-info --supported)
+UBUNTU_RELEASES=$(sort -u <(ubuntu-distro-info --supported-esm) <(ubuntu-distro-info --supported))
 
 cd trivy-repo/deb
 
@@ -9,12 +9,14 @@ for release in ${DEBIAN_RELEASES[@]} ${UBUNTU_RELEASES[@]}; do
   echo "Removing deb package of $release"
   reprepro -A i386 remove $release trivy
   reprepro -A amd64 remove $release trivy
+  reprepro -A arm64 remove $release trivy
 done
 
 for release in ${DEBIAN_RELEASES[@]} ${UBUNTU_RELEASES[@]}; do
   echo "Adding deb package to $release"
   reprepro includedeb $release ../../dist/*Linux-64bit.deb
   reprepro includedeb $release ../../dist/*Linux-32bit.deb
+  reprepro includedeb $release ../../dist/*Linux-ARM64.deb
 done
 
 git add .

codecov.yml

@@ -1,12 +0,0 @@
-coverage:
-  status:
-    project:
-      default:
-        informational: true
-        target: auto
-        threshold: 100%
-    patch:
-      default:
-        informational: true
-        target: auto
-        threshold: 100%

contrib/Trivy.gitlab-ci.yml

@@ -10,7 +10,7 @@ Trivy_container_scanning:
     IMAGE: "$CI_REGISTRY_IMAGE:$CI_COMMIT_SHA"
   allow_failure: true
   before_script:
-    - export TRIVY_VERSION=${TRIVY_VERSION:-v0.4.3}
+    - export TRIVY_VERSION=${TRIVY_VERSION:-v0.19.2}
     - apk add --no-cache curl docker-cli
     - docker login -u "$CI_REGISTRY_USER" -p "$CI_REGISTRY_PASSWORD" $CI_REGISTRY
     - curl -sfL https://raw.githubusercontent.com/aquasecurity/trivy/main/contrib/install.sh | sh -s -- -b /usr/local/bin ${TRIVY_VERSION}

contrib/asff.tpl

@@ -8,24 +8,13 @@
 {{- else -}}
   ,
 {{- end -}}
-{{- $trivyProductSev := 0 -}}
-{{- $trivyNormalizedSev := 0 -}}
-{{- if eq .Severity "LOW" -}}
-    {{- $trivyProductSev = 1 -}}
-    {{- $trivyNormalizedSev = 10 -}}
-  {{- else if eq .Severity "MEDIUM" -}}
-    {{- $trivyProductSev = 4 -}}
-    {{- $trivyNormalizedSev = 40 -}}
-  {{- else if eq .Severity "HIGH" -}}
-    {{- $trivyProductSev = 7 -}}
-    {{- $trivyNormalizedSev = 70 -}}
-  {{- else if eq .Severity "CRITICAL" -}}
-    {{- $trivyProductSev = 9 -}}
-    {{- $trivyNormalizedSev = 90 -}}
-{{- end }}
+{{- $severity := .Severity -}}
+{{- if eq $severity "UNKNOWN" -}}
+{{- $severity = "INFORMATIONAL" -}}
+{{- end -}}
 {{- $description := .Description -}}
 {{- if gt (len $description ) 1021 -}}
-    {{- $description = (slice $description 0 1021) | printf "%v .." -}}
+    {{- $description = (substr 0 1021 $description) | printf "%v .." -}}
 {{- end}}
     {
         "SchemaVersion": "2018-10-08",
@@ -37,8 +26,7 @@
         "CreatedAt": "{{ getCurrentTime }}",
         "UpdatedAt": "{{ getCurrentTime }}",
         "Severity": {
-            "Product": {{ $trivyProductSev }},
-            "Normalized": {{ $trivyNormalizedSev }}
+            "Label": "{{ $severity }}"
         },
         "Title": "Trivy found a vulnerability to {{ .VulnerabilityID }} in container {{ $target }}",
         "Description": {{ escapeString $description | printf "%q" }},
@@ -75,4 +63,4 @@
     }
    {{- end -}}
   {{- end }}
-]
+]

contrib/gitlab-codequality.tpl

@@ -0,0 +1,38 @@
+{{- /* Template based on https://github.com/codeclimate/platform/blob/master/spec/analyzers/SPEC.md#data-types */ -}}
+[
+  {{- $t_first := true }}
+  {{- range . }}
+  {{- $target := .Target }}
+    {{- range .Vulnerabilities -}}
+    {{- if $t_first -}}
+      {{- $t_first = false -}}
+    {{ else -}}
+      ,
+    {{- end }}
+    {
+      "type": "issue",
+      "check_name": "container_scanning",
+      "categories": [ "Security" ],
+      "description": "{{ .VulnerabilityID }}: {{ .Title }}",
+      "content": {{ .Description | printf "%q" }},
+      "severity": {{ if eq .Severity "LOW" -}}
+                    "info"
+                  {{- else if eq .Severity "MEDIUM" -}}
+                    "minor"
+                  {{- else if eq .Severity "HIGH" -}}
+                    "major"
+                  {{- else if eq .Severity "CRITICAL" -}}
+                    "critical"
+                  {{-  else -}}
+                    "info"
+                  {{- end }},
+      "location": {
+        "path": "{{ .PkgName }}-{{ .InstalledVersion }}",
+        "lines": {
+          "begin": 1
+        }
+      }
+    }
+    {{- end -}}
+  {{- end }}
+]

contrib/html.tpl

@@ -112,6 +112,31 @@
       </tr>
         {{- end }}
       {{- end }}
+      {{- if (eq (len .Misconfigurations ) 0) }}
+      <tr><th colspan="6">No Misconfigurations found</th></tr>
+      {{- else }}
+      <tr class="sub-header">
+        <th>Type</th>
+        <th>Misconf ID</th>
+        <th>Check</th>
+        <th>Severity</th>
+        <th>Message</th>
+      </tr>
+        {{- range .Misconfigurations }}
+      <tr class="severity-{{ escapeXML .Severity }}">
+        <td class="misconf-type">{{ escapeXML .Type }}</td>
+        <td>{{ escapeXML .ID }}</td>
+        <td class="misconf-check">{{ escapeXML .Title }}</td>
+        <td class="severity">{{ escapeXML .Severity }}</td>
+        <td class="link" data-more-links="off"  style="white-space:normal;"">
+          {{ escapeXML .Message }}
+          <br>
+            <a href={{ escapeXML .PrimaryURL | printf "%q" }}>{{ escapeXML .PrimaryURL }}</a>
+          </br>
+        </td>
+      </tr>
+        {{- end }}
+      {{- end }}
     {{- end }}
     </table>
 {{- else }}

contrib/install.sh

@@ -182,11 +182,11 @@ log_tag() {
 }
 log_debug() {
   log_priority 7 || return 0
-  echoerr "$(log_prefix)" "$(log_tag 7)" "$@"
+  echo "$(log_prefix)" "$(log_tag 7)" "$@"
 }
 log_info() {
   log_priority 6 || return 0
-  echoerr "$(log_prefix)" "$(log_tag 6)" "$@"
+  echo "$(log_prefix)" "$(log_tag 6)" "$@"
 }
 log_err() {
   log_priority 3 || return 0

contrib/sarif.tpl

@@ -1,6 +1,7 @@
 {
   "$schema": "https://raw.githubusercontent.com/oasis-tcs/sarif-spec/master/Schemata/sarif-schema-2.1.0.json",
   "version": "2.1.0",
+  {{- $rules := makeRuleMap }}
   "runs": [
     {
       "tool": {
@@ -11,45 +12,46 @@
           "version": "0.15.0",
           "rules": [
         {{- $t_first := true }}
-        {{- range . }}
+        {{- range $result := . }}
             {{- $vulnerabilityType := .Type }}
             {{- range .Vulnerabilities -}}
-              {{- if $t_first -}}
-                {{- $t_first = false -}}
-              {{ else -}}
-                ,
-              {{- end }}
-            {
-              "id": "{{ .VulnerabilityID }}/{{ .PkgName }}",
-              "name": "{{ toSarifRuleName $vulnerabilityType }}",
-              "shortDescription": {
-                "text": {{ printf "%v Package: %v" .VulnerabilityID .PkgName | printf "%q" }}
-              },
-              "fullDescription": {
-                "text": {{ endWithPeriod (escapeString .Title) | printf "%q" }}
-              },
-              "defaultConfiguration": {
-                "level": "{{ toSarifErrorLevel .Vulnerability.Severity }}"
-              }
-              {{- with $help_uri := .PrimaryURL -}}
-              ,
-              {{ $help_uri | printf "\"helpUri\": %q," -}}
-              {{- else -}}
-              ,
-              {{- end }}
-              "help": {
-                "text": {{ printf "Vulnerability %v\nSeverity: %v\nPackage: %v\nInstalled Version: %v\nFixed Version: %v\nLink: [%v](%v)" .VulnerabilityID .Vulnerability.Severity .PkgName .InstalledVersion .FixedVersion .VulnerabilityID .PrimaryURL | printf "%q"}},
-                "markdown": {{ printf "**Vulnerability %v**\n| Severity | Package | Installed Version | Fixed Version | Link |\n| --- | --- | --- | --- | --- |\n|%v|%v|%v|%v|[%v](%v)|\n" .VulnerabilityID .Vulnerability.Severity .PkgName .InstalledVersion .FixedVersion .VulnerabilityID .PrimaryURL | printf "%q"}}
-              },
-              "properties": {
-                "tags": [
-                  "vulnerability",
-                  "{{ .Vulnerability.Severity }}",
-                  {{ .PkgName | printf "%q" }}
-                ],
-                "precision": "very-high"
-              }
-            }
+                {{- if indexRule $rules .VulnerabilityID -}}
+                  {{- if $t_first -}}
+                    {{- $t_first = false -}}
+                  {{ else -}}
+                    ,
+                  {{- end }}
+                {
+                  "id": {{ .VulnerabilityID | toJson }},
+                  "name": "{{ toSarifRuleName $vulnerabilityType }}",
+                  "shortDescription": {
+                    "text": {{ .VulnerabilityID | toJson }}
+                  },
+                  "fullDescription": {
+                    "text": {{ endWithPeriod (escapeString .Title) | printf "%q" }}
+                  },
+                  "defaultConfiguration": {
+                    "level": "{{ toSarifErrorLevel .Vulnerability.Severity }}"
+                  }
+                  {{- with $help_uri := .PrimaryURL -}}
+                  ,
+                  {{ $help_uri | printf "\"helpUri\": %q," -}}
+                  {{- else -}}
+                  ,
+                  {{- end }}
+                  "help": {
+                    "text": {{ printf "Vulnerability %v\n%v\nSeverity: %v\nPackage: %v\nFixed Version: %v\nLink: [%v](%v)" .VulnerabilityID .Vulnerability.Description .Vulnerability.Severity .PkgName .FixedVersion .VulnerabilityID .PrimaryURL | printf "%q"}},                    
+                    "markdown": {{ printf "**Vulnerability %v**\n%v\n| Severity | Package | Fixed Version | Link |\n| --- | --- | --- | --- |\n|%v|%v|%v|[%v](%v)|\n" .VulnerabilityID .Vulnerability.Description .Vulnerability.Severity .PkgName .FixedVersion .VulnerabilityID .PrimaryURL | printf "%q"}}                    
+                  },
+                  "properties": {
+                    "tags": [
+                      "vulnerability",
+                      "{{ .Vulnerability.Severity }}"
+                    ],
+                    "precision": "very-high"
+                  }
+                }
+                {{- end -}}
             {{- end -}}
          {{- end -}}
           ]
@@ -57,7 +59,7 @@
       },
       "results": [
     {{- $t_first := true }}
-    {{- range . }}
+    {{- range $result := . }}
         {{- $filePath := .Target }}
         {{- range $index, $vulnerability := .Vulnerabilities -}}
           {{- if $t_first -}}
@@ -66,17 +68,20 @@
             ,
           {{- end }}
         {
-          "ruleId": "{{ $vulnerability.VulnerabilityID }}/{{ $vulnerability.PkgName }}",
-          "ruleIndex": {{ $index }},
+          "ruleId": {{ .VulnerabilityID | toJson }},
+          "ruleIndex": {{ index $rules .VulnerabilityID }},
           "level": "{{ toSarifErrorLevel $vulnerability.Vulnerability.Severity }}",
           "message": {
-            "text": {{ endWithPeriod (escapeString $vulnerability.Description) | printf "%q" }}
+            "text": {{ printf "Package: %v\nInstalled Version: %v\nVulnerability %v\nSeverity: %v\nFixed Version: %v\nLink: [%v](%v)" .PkgName .InstalledVersion .VulnerabilityID .Vulnerability.Severity .FixedVersion .VulnerabilityID .PrimaryURL | printf "%q"}}
           },
           "locations": [{
             "physicalLocation": {
               "artifactLocation": {
                 "uri": "{{ toPathUri $filePath }}",
                 "uriBaseId": "ROOTPATH"
+              },
+              "region" : {
+                "startLine": 1
               }
             }
           }]
@@ -87,9 +92,9 @@
       "columnKind": "utf16CodeUnits",
       "originalUriBaseIds": {
         "ROOTPATH": {
-          "uri": "/"
+          "uri": "file:///"
         }
       }
     }
   ]
-}
+}

docs/advanced/air-gap.md

@@ -0,0 +1,119 @@
+# Air-Gapped Environment
+
+Trivy can be used in air-gapped environments.
+
+
+## Air-Gapped Environment for vulnerabilities
+
+### Download the vulnerability database
+At first, you need to download the vulnerability database for use in air-gapped environments.
+Go to [trivy-db][trivy-db] and download `trivy-offline.db.tgz` in the latest release.
+If you download `trivy-light-offline.db.tgz`, you have to run Trivy with `--light` option.
+
+```
+$ wget https://github.com/aquasecurity/trivy-db/releases/latest/download/trivy-offline.db.tgz
+```
+
+### Transfer the DB file into the air-gapped environment
+The way of transfer depends on the environment.
+
+```
+$ rsync -av -e ssh /path/to/trivy-offline.db.tgz [user]@[host]:dst
+```
+
+### Put the DB file in Trivy's cache directory
+You have to know where to put the DB file. The following command shows the default cache directory.
+
+```
+$ ssh user@host
+$ trivy -h | grep cache
+   --cache-dir value  cache directory (default: "/home/myuser/.cache/trivy") [$TRIVY_CACHE_DIR]
+```
+
+Put the DB file in the cache directory + `/db`.
+
+```
+$ mkdir -p /home/myuser/.cache/trivy/db
+$ cd /home/myuser/.cache/trivy/db
+$ mv /path/to/trivy-offline.db.tgz .
+```
+
+Then, decompress it.
+`trivy-offline.db.tgz` file includes two files, `trivy.db` and `metadata.json`.
+
+```
+$ tar xvf trivy-offline.db.tgz
+x trivy.db
+x metadata.json
+$ rm trivy-offline.db.tgz
+```
+
+In an air-gapped environment it is your responsibility to update the Trivy database on a regular basis, so that the scanner can detect recently-identified vulnerabilities. 
+
+### Run Trivy with --skip-update and --offline-scan option
+In an air-gapped environment, specify `--skip-update` so that Trivy doesn't attempt to download the latest database file.
+In addition, if you want to scan Java dependencies such as JAR and pom.xml, you need to specify `--offline-scan` since Trivy tries to issue API requests for scanning Java applications by default.
+
+```
+$ trivy image --skip-update --offline-scan alpine:3.12
+```
+
+## Air-Gapped Environment for misconfigurations
+
+### Download misconfiguration policies
+At first, you need to download misconfiguration policies for use in air-gapped environments.
+Please follow [oras installation instruction][oras]. \
+Download `bundle.tar.gz`:
+
+```
+$ oras pull ghcr.io/aquasecurity/appshield:latest -a
+```
+
+### Transfer misconfiguration policies into the air-gapped environment
+The way of transfer depends on the environment.
+
+```
+$ rsync -av -e ssh /path/to/bundle.tar.gz [user]@[host]:dst
+```
+
+### Put the misconfiguration policies in Trivy's cache directory
+You have to know where to put the misconfiguration policies file. The following command shows the default cache directory.
+
+```
+$ ssh user@host
+$ trivy -h | grep cache
+   --cache-dir value  cache directory (default: "/home/myuser/.cache/trivy") [$TRIVY_CACHE_DIR]
+```
+
+Put the misconfiguration policies file in the cache directory + `/policy/content`.
+
+```
+$ mkdir -p /home/myuser/.cache/trivy/policy/content
+$ cd /home/myuser/.cache/trivy/policy/content
+$ mv /path/to/bundle.tar.gz .
+```
+
+Then, decompress it.
+`bundle.tar.gz ` file includes two folders: `docker`, `kubernetes` and file: `.manifest`.
+
+```
+$ tar xvf bundle.tar.gz 
+x ./docker/
+...
+x ./kubernetes/
+...
+x ./.manifest
+$ rm bundle.tar.gz
+```
+
+In an air-gapped environment it is your responsibility to update policies on a regular basis, so that the scanner can detect recently-identified misconfigurations. 
+
+### Run Trivy with --skip-policy-update option
+In an air-gapped environment, specify `--skip-policy-update` so that Trivy doesn't attempt to download the latest misconfiguration policies.
+
+```
+$ trivy conf --skip-policy-update /path/to/conf
+```
+
+[trivy-db]: https://github.com/aquasecurity/trivy-db/releases
+[oras]: https://oras.land/cli/

docs/advanced/community/references.md

@@ -0,0 +1,19 @@
+# External References
+There are external blogs and evaluations.
+
+## Blogs
+- [the vulnerability remediation lifecycle of Alpine containers][alpine]
+- [Continuous Container Vulnerability Testing with Trivy][semaphore]
+- [Open Source CVE Scanner Round-Up: Clair vs Anchore vs Trivy][round-up]
+- [Docker Image Security: Static Analysis Tool Comparison – Anchore Engine vs Clair vs Trivy][tool-comparison]
+
+## Links
+- [Research Spike: evaluate Trivy for scanning running containers][gitlab]
+- [Istio evaluates scanners][istio]
+
+[alpine]: https://ariadne.space/2021/06/08/the-vulnerability-remediation-lifecycle-of-alpine-containers/
+[semaphore]: https://semaphoreci.com/blog/continuous-container-vulnerability-testing-with-trivy
+[round-up]: https://boxboat.com/2020/04/24/image-scanning-tech-compared/
+[tool-comparison]: https://www.a10o.net/devsecops/docker-image-security-static-analysis-tool-comparison-anchore-engine-vs-clair-vs-trivy/
+[gitlab]: https://gitlab.com/gitlab-org/gitlab/-/issues/270888
+[istio]: https://github.com/istio/release-builder/pull/687#issuecomment-874938417

docs/advanced/community/tools.md

@@ -0,0 +1,37 @@
+# Community Tools
+The open source community has been hard at work developing new tools for Trivy. You can check out some of them here.
+
+Have you created a tool that’s not listed? Add the name and description of your integration and open a pull request in the GitHub repository to get your change merged.
+
+## GitHub Actions
+
+| Actions                                    | Description                                                                      |
+| ------------------------------------------ | -------------------------------------------------------------------------------- |
+| [gitrivy][gitrivy]                         | GitHub Issue + Trivy                                                             |
+| [trivy-github-issues][trivy-github-issues] | GitHub Actions for creating GitHub Issues according to the Trivy scanning result |
+
+## Semaphore
+
+| Name                                                   | Description                               |
+| -------------------------------------------------------| ----------------------------------------- |
+| [Continuous Vulnerability Testing with Trivy][semaphore-tutorial] | Tutorial on scanning code, containers, infrastructure, and Kubernetes with Semaphore CI/CD. |
+
+
+## CircleCI
+
+| Orb                                      | Description                               |
+| -----------------------------------------| ----------------------------------------- |
+| [fifteen5/trivy-orb][fifteen5/trivy-orb] | Orb for running Trivy, a security scanner |
+
+## Others
+
+| Name                                     | Description                               |
+| -----------------------------------------| ----------------------------------------- |
+| [Trivy Vulnerability Explorer][explorer] | Explore trivy vulnerability reports in your browser and create .trivyignore files interactively. Can be integrated in your CI/CD tooling with deep links.   |
+
+
+[trivy-github-issues]: https://github.com/marketplace/actions/trivy-github-issues
+[fifteen5/trivy-orb]: https://circleci.com/developer/orbs/orb/fifteen5/trivy-orb
+[gitrivy]: https://github.com/marketplace/actions/trivy-action
+[explorer]: https://dbsystel.github.io/trivy-vulnerability-explorer/
+[semaphore-tutorial]: https://semaphoreci.com/blog/continuous-container-vulnerability-testing-with-trivy

docs/advanced/container/embed-in-dockerfile.md

@@ -10,7 +10,7 @@ FROM alpine:3.7
 
 RUN apk add curl \
     && curl -sfL https://raw.githubusercontent.com/aquasecurity/trivy/main/contrib/install.sh | sh -s -- -b /usr/local/bin \
-    && trivy filesystem --exit-code 1 --no-progress /
+    && trivy rootfs --exit-code 1 --no-progress /
 
 $ docker build -t vulnerable-image .
 ```
@@ -21,7 +21,7 @@ insecure `curl | sh`. Also the image is not changed.
 # Run vulnerability scan on build image
 FROM build AS vulnscan
 COPY --from=aquasec/trivy:latest /usr/local/bin/trivy /usr/local/bin/trivy
-RUN trivy filesystem --exit-code 1 --no-progress /
+RUN trivy rootfs --exit-code 1 --no-progress /
 [...]
 ```
 

docs/advanced/container/oci.md

@@ -1,6 +1,6 @@
-# OCI
+# OCI Image Layout
 
-An image directory compliant with "Open Container Image Layout Specification".
+An image directory compliant with [Open Container Image Layout Specification](https://github.com/opencontainers/image-spec/blob/master/spec.md).
 
 Buildah:
 

docs/advanced/container/podman.md

@@ -1,10 +1,12 @@
 # Podman
 
-[EXPERIMENTAL] This feature might change without preserving backwards compatibility.
+!!! warning "EXPERIMENTAL"
+    This feature might change without preserving backwards compatibility.
 
 Scan your image in Podman (>=2.0) running locally. The remote Podman is not supported.
 Before performing Trivy commands, you must enable the podman.sock systemd service on your machine.
-For more details, see [here][sock]
+For more details, see [here][sock].
+
 
 ```bash
 $ systemctl --user enable --now podman.socket

docs/advanced/container/unpacked-filesystem.md

@@ -1,12 +1,12 @@
 # Unpacked Filesystem
 
-Scan aan unpacked container image filesystem.
+Scan an unpacked container image filesystem.
 
 In this case, Trivy works the same way when scanning containers
 
 ```bash
 $ docker export $(docker create alpine:3.10.2) | tar -C /tmp/rootfs -xvf -
-$ trivy fs /tmp/rootfs
+$ trivy rootfs /tmp/rootfs
 ```
 
 <details>

docs/advanced/contrib/triage.md

@@ -185,7 +185,7 @@ We use two labels [help wanted](https://github.com/aquasecurity/trivy/issues?q=i
 and [good first issue](https://github.com/aquasecurity/trivy/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22)
 to identify issues that have been specially groomed for new contributors.
 
-We have specific [guidelines](/docs/contrib/help-wanted.md)
+We have specific [guidelines](/docs/advanced/contribd/contrib/help-wanted.md)
 for how to use these labels. If you see an issue that satisfies these
 guidelines, you can add the `help wanted` label and the `good first issue` label.
 Please note that adding the `good first issue` label must also 

docs/advanced/index.md

@@ -0,0 +1,2 @@
+# Advanced
+This section describes advanced features, integrations, etc.

docs/advanced/integrations/bitbucket.md

@@ -0,0 +1,5 @@
+# Bitbucket Pipelines
+
+See [trivy-pipe][trivy-pipe] for the details.
+
+[trivy-pipe]: https://github.com/aquasecurity/trivy-pipe

docs/advanced/integrations/github-actions.md

@@ -1,7 +1,7 @@
 # GitHub Actions
 
 - Here is the [Trivy Github Action][action]
-- The Microsoft Azure team have written a [container-scan action][azuer] that uses Trivy and Dockle
+- The Microsoft Azure team have written a [container-scan action][azure] that uses Trivy and Dockle
 - For full control over the options specified to Trivy, this [blog post][blog] describes adding Trivy into your own GitHub action workflows 
 
 [action]: https://github.com/aquasecurity/trivy-action

docs/advanced/integrations/gitlab-ci.md

@@ -1,7 +1,12 @@
 # GitLab CI
 
-```
-$ cat .gitlab-ci.yml
+If you're a GitLab Ultimate customer, GitLab 14.0 and above include out-of-the-box integration with Trivy. To enable it for your project, simply add the container scanning template to your `.gitlab-ci.yml` file. For more details, please refer to [GitLab's documentation](https://docs.gitlab.com/ee/user/application_security/container_scanning/).
+
+If you're using an earlier version of GitLab, you can still use the new integration by copying the [contents of the 14.0 template](https://gitlab.com/gitlab-org/gitlab/blob/master/lib/gitlab/ci/templates/Security/Container-Scanning.gitlab-ci.yml) to your configuration.
+
+Alternatively, you can always use the example configurations below.
+
+```yaml
 stages:
   - test
 
@@ -78,7 +83,7 @@ container_scanning:
         --output "$CI_PROJECT_DIR/gl-container-scanning-report.json" "$FULL_IMAGE_NAME"
     # Prints full report
     - time trivy --exit-code 0 --cache-dir .trivycache/ --no-progress "$FULL_IMAGE_NAME"
-    # Fails on high and critical vulnerabilities
+    # Fail on critical vulnerabilities
     - time trivy --exit-code 1 --cache-dir .trivycache/ --severity CRITICAL --no-progress "$FULL_IMAGE_NAME"
   cache:
     paths:
@@ -94,3 +99,59 @@ container_scanning:
 
 [example]: https://gitlab.com/aquasecurity/trivy-ci-test/pipelines
 [repository]: https://github.com/aquasecurity/trivy-ci-test
+
+### Gitlab CI alternative template
+
+Depending on the edition of gitlab you have or your desired workflow, the
+container scanning template may not meet your needs. As an addition to the
+above container scanning template, a template for
+[code climate](https://docs.gitlab.com/ee/user/project/merge_requests/code_quality.html)
+has been included. The key things to update from the above examples are
+the `template` and `report` type. An updated example is below.
+
+```yaml
+stages:
+  - test
+
+trivy:
+  stage: test
+  image: docker:stable
+  services:
+    - name: docker:dind
+      entrypoint: ["env", "-u", "DOCKER_HOST"]
+      command: ["dockerd-entrypoint.sh"]
+  variables:
+    DOCKER_HOST: tcp://docker:2375/
+    DOCKER_DRIVER: overlay2
+    # See https://github.com/docker-library/docker/pull/166
+    DOCKER_TLS_CERTDIR: ""
+    IMAGE: trivy-ci-test:$CI_COMMIT_SHA
+  before_script:
+    - export TRIVY_VERSION=$(wget -qO - "https://api.github.com/repos/aquasecurity/trivy/releases/latest" | grep '"tag_name":' | sed -E 's/.*"v([^"]+)".*/\1/')
+    - echo $TRIVY_VERSION
+    - wget --no-verbose https://github.com/aquasecurity/trivy/releases/download/v${TRIVY_VERSION}/trivy_${TRIVY_VERSION}_Linux-64bit.tar.gz -O - | tar -zxvf -
+  allow_failure: true
+  script:
+    # Build image
+    - docker build -t $IMAGE .
+    # Build report
+    - ./trivy --exit-code 0 --cache-dir .trivycache/ --no-progress --format template --template "@contrib/gitlab-codeclimate.tpl" -o gl-codeclimate.json $IMAGE
+  cache:
+    paths:
+      - .trivycache/
+  # Enables https://docs.gitlab.com/ee/user/application_security/container_scanning/ (Container Scanning report is available on GitLab EE Ultimate or GitLab.com Gold)
+  artifacts:
+    paths:
+      gl-codeclimate.json
+    reports:
+      codequality: gl-codeclimate.json
+```
+
+Currently gitlab only supports a single code quality report. There is an
+open [feature request](https://gitlab.com/gitlab-org/gitlab/-/issues/9014)
+to support multiple reports. Until this has been implemented, if you
+already have a code quality report in your pipeline, you can use
+`jq` to combine reports. Depending on how you name your artifacts, it may
+be necessary to rename the artifact if you want to reuse the name. To then
+combine the previous artifact with the output of trivy, the following `jq`
+command can be used, `jq -s 'add' prev-codeclimate.json trivy-codeclimate.json > gl-codeclimate.json`.

docs/advanced/integrations/index.md

@@ -1,3 +1,4 @@
+# Integrations
 Scan your image automatically as part of your CI workflow, failing the workflow if a vulnerability is found. When you don't want to fail the test, specify `--exit-code 0`.
 
 Since in automated scenarios such as CI/CD you are only interested in the end result, and not the full report, use the `--light` flag to optimize for this scenario and get fast results.

docs/advanced/modes/client-server.md

@@ -55,5 +55,5 @@ $ trivy client --remote http://localhost:8080 --token dummy alpine:3.10
 
 ## Architecture
 
-![architecture](../imgs/client-server.png)
+![architecture](../../imgs/client-server.png)
 

docs/advanced/modes/standalone.md

@@ -4,13 +4,13 @@
 
 ## Image
 
-![standalone](../imgs/image.png)
+![standalone](../../imgs/image.png)
 
 ## Filesystem
 
-![fs](../imgs/fs.png)
+![fs](../../imgs/fs.png)
 
 ## Git Repository
 
-![repo](../imgs/repo.png)
+![repo](../../imgs/repo.png)
 

docs/advanced/private-registries/gcr.md

@@ -0,0 +1,40 @@
+# Requirements
+None, Trivy uses Google Cloud SDK. You don't need to install `gcloud` command.
+
+# Privileges
+Credential file must have the `roles/storage.objectViewer` permissions.
+More information can be found in [Google's documentation](https://cloud.google.com/container-registry/docs/access-control)
+
+## JSON File Format
+The JSON file specified should have the following format provided by google's service account mechanisms:
+
+```json
+{
+  "type": "service_account",
+  "project_id": "your_special_project",
+  "private_key_id": "XXXXXXXXXXXXXXXXXXXXxx",
+  "private_key": "-----BEGIN PRIVATE KEY-----\nNONONONO\n-----END PRIVATE KEY-----\n",
+  "client_email": "somedude@your_special_project.iam.gserviceaccount.com",
+  "client_id": "1234567890",
+  "auth_uri": "https://accounts.google.com/o/oauth2/auth",
+  "token_uri": "https://oauth2.googleapis.com/token",
+  "auth_provider_x509_cert_url": "https://www.googleapis.com/oauth2/v1/certs",
+  "client_x509_cert_url": "https://www.googleapis.com/robot/v1/metadata/x509/somedude%40your_special_project.iam.gserviceaccount.com"
+}
+```
+
+# Usage
+If you want to use target project's repository, you can set them via `GOOGLE_APPLICATION_CREDENTIALS`.
+```bash
+# must set TRIVY_USERNAME empty char
+export GOOGLE_APPLICATION_CREDENTIALS=/path/to/credential.json
+```
+
+# Testing
+You can test credentials in the following manner (assuming they are in `/tmp` on host machine).
+
+```bash
+docker run -it --rm -v /tmp:/tmp\
+  -e GOOGLE_APPLICATION_CREDENTIALS=/tmp/service_account.json\
+  aquasec/trivy image gcr.io/your_special_project/your_special_image:your_special_tag
+```

docs/air-gap.md

@@ -1,57 +0,0 @@
-# Air-Gapped Environment
-
-Trivy can be used in air-gapped environments.
-
-## Download the vulnerability database
-At first, you need to download the vulnerability database for use in air-gapped environments.
-Go to [trivy-db][trivy-db] and download `trivy-offline.db.tgz` in the latest release.
-If you download `trivy-light-offline.db.tgz`, you have to run Trivy with `--light` option.
-
-```
-$ wget https://github.com/aquasecurity/trivy-db/releases/latest/download/trivy-offline.db.tgz
-```
-
-## Transfer the DB file into the air-gapped environment
-The way of transfer depends on the environment.
-
-```
-$ rsync -av -e ssh /path/to/trivy-offline.db.tgz [user]@[host]:dst
-```
-
-## Put the DB file in Trivy's cache directory
-You have to know where to put the DB file. The following command shows the default cache directory.
-
-```
-$ ssh user@host
-$ trivy -h | grep cache
-   --cache-dir value  cache directory (default: "/home/myuser/.cache/trivy") [$TRIVY_CACHE_DIR]
-```
-
-Put the DB file in the cache directory + `/db`.
-
-```
-$ mkdir -p /home/myuser/.cache/trivy/db
-$ cd /home/myuser/.cache/trivy/db
-$ mv /path/to/trivy-offline.db.tgz .
-```
-
-Then, decompress it.
-`trivy-offline.db.tgz` file includes two files, `trivy.db` and `metadata.json`.
-
-```
-$ tar xvf trivy-offline.db.tgz
-x trivy.db
-x metadata.json
-$ rm trivy-offline.db.tgz
-```
-
-In an air-gapped environment it is your responsibility to update the Trivy database on a regular basis, so that the scanner can detect recently-identified vulnerabilities. 
-
-## Run Trivy with --skip-update option
-In an air-gapped environment, specify `--skip-update` so that Trivy doesn't attempt to download the latest database file.
-
-```
-$ trivy image --skip-update alpine:3.12
-```
-
-[trivy-db]: https://github.com/aquasecurity/trivy-db/releases

docs/build/Dockerfile

@@ -1,4 +1,4 @@
-FROM squidfunk/mkdocs-material
+FROM squidfunk/mkdocs-material:7.0.6
 
 ## If you want to see exactly the same version as is published to GitHub pages
 ## use a private image for insiders, which requires authentication.

docs/comparison.md

@@ -1,17 +0,0 @@
-# Comparison with other scanners
-
-| Scanner        | OS<br>Packages  | Application<br>Dependencies | Easy to use  | Accuracy    | Suitable<br>for CI  |
-| -------------- | :-------------: | :-------------------------: | :----------: | :---------: | :-----------------: |
-| Trivy          |       ✅        |       ✅<br>(8 languages)   |    ⭐ ⭐ ⭐    |  ⭐ ⭐ ⭐    |      ⭐ ⭐ ⭐         |
-| Clair          |       ✅        |              ×              |      ⭐       |   ⭐ ⭐      |      ⭐ ⭐           |
-| Anchore Engine |       ✅        |       ✅<br>(4 languages)   |     ⭐ ⭐      |   ⭐ ⭐      |     ⭐ ⭐ ⭐         |
-| Quay           |       ✅        |              ×              |    ⭐ ⭐ ⭐    |   ⭐ ⭐      |        ×            |
-| Docker Hub     |       ✅        |              ×              |    ⭐ ⭐ ⭐    |    ⭐        |        ×            |
-| GCR            |       ✅        |              ×              |    ⭐ ⭐ ⭐    |   ⭐ ⭐      |        ×            |
-
-- [Open Source CVE Scanner Round-Up: Clair vs Anchore vs Trivy][round-up]
-- [Docker Image Security: Static Analysis Tool Comparison – Anchore Engine vs Clair vs Trivy][tool-comparison]
-- [Research Spike: evaluate Trivy for scanning running containers](https://gitlab.com/gitlab-org/gitlab/-/issues/270888)
-
-[round-up]: https://boxboat.com/2020/04/24/image-scanning-tech-compared/
-[tool-comparison]: https://www.a10o.net/devsecops/docker-image-security-static-analysis-tool-comparison-anchore-engine-vs-clair-vs-trivy/

docs/credit.md

@@ -1,14 +0,0 @@
-# Special Thanks to 
-
-- [Tomoya Amachi][tomoyamachi]
-- [Masahiro Fujimura][masahiro331]
-- [Naoki Harima][XapiMa]
-
-# Author
-
-[Teppei Fukuda][knqyf263] (knqyf263)
-
-[tomoyamachi]: https://github.com/tomoyamachi
-[masahiro331]: https://github.com/masahiro331
-[XapiMa]: https://github.com/XapiMa
-[knqyf263]: https://github.com/knqyf263

docs/examples/index.md

@@ -1,3 +0,0 @@
-# Examples
-
-There are plenty of examples.

docs/examples/skip.md

@@ -1,17 +0,0 @@
-# Skip Traversal of Files/Directories
-
-## Skip Files
-Trivy traversals directories and looks for all lock files by default.
-If your image contains lock files which are not maintained by you, you can skip the file.
-
-```
-$ trivy image --skip-files "/Gemfile.lock" --skip-files "/var/lib/gems/2.5.0/gems/http_parser.rb-0.6.0/Gemfile.lock" quay.io/fluentd_elasticsearch/fluentd:v2.9.0
-```
-
-## Skip Directories
-Trivy traversals directories and look for all lock files by default.
-If your image contains lock files which are not maintained by you, you can skip traversal in the specific directory.
-
-```
-$ trivy image --skip-dirs /var/lib/gems/2.5.0/gems/fluent-plugin-detect-exceptions-0.0.13 --skip-dirs "/var/lib/gems/2.5.0/gems/http_parser.rb-0.6.0" quay.io/fluentd_elasticsearch/fluentd:v2.9.0
-```

docs/getting-started/cli/client.md

@@ -21,6 +21,8 @@ OPTIONS:
    --ignorefile value          specify .trivyignore file (default: ".trivyignore") [$TRIVY_IGNOREFILE]
    --timeout value             timeout (default: 5m0s) [$TRIVY_TIMEOUT]
    --ignore-policy value       specify the Rego file to evaluate each vulnerability [$TRIVY_IGNORE_POLICY]
+   --list-all-pkgs             enabling the option will output all packages regardless of vulnerability (default: false) [$TRIVY_LIST_ALL_PKGS]
+   --offline-scan              do not issue API requests to identify dependencies (default: false) [$TRIVY_OFFLINE_SCAN]
    --token value               for authentication [$TRIVY_TOKEN]
    --token-header value        specify a header name for token (default: "Trivy-Token") [$TRIVY_TOKEN_HEADER]
    --remote value              server address (default: "http://localhost:4954") [$TRIVY_REMOTE]

docs/getting-started/cli/config.md

@@ -0,0 +1,29 @@
+# Config
+
+``` bash
+NAME:
+   trivy config - scan config files
+
+USAGE:
+   trivy config [command options] dir
+
+OPTIONS:
+   --template value, -t value                     output template [$TRIVY_TEMPLATE]
+   --format value, -f value                       format (table, json, template) (default: "table") [$TRIVY_FORMAT]
+   --severity value, -s value                     severities of vulnerabilities to be displayed (comma separated) (default: "UNKNOWN,LOW,MEDIUM,HIGH,CRITICAL") [$TRIVY_SEVERITY]
+   --output value, -o value                       output file name [$TRIVY_OUTPUT]
+   --exit-code value                              Exit code when vulnerabilities were found (default: 0) [$TRIVY_EXIT_CODE]
+   --skip-policy-update                           skip updating built-in policies (default: false) [$TRIVY_SKIP_POLICY_UPDATE]
+   --reset                                        remove all caches and database (default: false) [$TRIVY_RESET]
+   --clear-cache, -c                              clear image caches without scanning (default: false) [$TRIVY_CLEAR_CACHE]
+   --ignorefile value                             specify .trivyignore file (default: ".trivyignore") [$TRIVY_IGNOREFILE]
+   --timeout value                                timeout (default: 5m0s) [$TRIVY_TIMEOUT]
+   --skip-files value                             specify the file paths to skip traversal [$TRIVY_SKIP_FILES]
+   --skip-dirs value                              specify the directories where the traversal is skipped [$TRIVY_SKIP_DIRS]
+   --policy value, --config-policy value          specify paths to the Rego policy files directory, applying config files [$TRIVY_POLICY]
+   --data value, --config-data value              specify paths from which data for the Rego policies will be recursively loaded [$TRIVY_DATA]
+   --policy-namespaces value, --namespaces value  Rego namespaces (default: "users") [$TRIVY_POLICY_NAMESPACES]
+   --file-patterns value                          specify file patterns [$TRIVY_FILE_PATTERNS]
+   --include-successes                            include successes of misconfigurations (default: false) [$TRIVY_INCLUDE_SUCCESSES]
+   --help, -h                                     show help (default: false)
+```

docs/getting-started/cli/fs.md

@@ -0,0 +1,35 @@
+# Filesystem
+
+```bash
+NAME:
+   trivy filesystem - scan local filesystem
+
+USAGE:
+   trivy filesystem [command options] dir
+
+OPTIONS:
+   --template value, -t value                     output template [$TRIVY_TEMPLATE]
+   --format value, -f value                       format (table, json, template) (default: "table") [$TRIVY_FORMAT]
+   --severity value, -s value                     severities of vulnerabilities to be displayed (comma separated) (default: "UNKNOWN,LOW,MEDIUM,HIGH,CRITICAL") [$TRIVY_SEVERITY]
+   --output value, -o value                       output file name [$TRIVY_OUTPUT]
+   --exit-code value                              Exit code when vulnerabilities were found (default: 0) [$TRIVY_EXIT_CODE]
+   --skip-db-update, --skip-update                skip updating vulnerability database (default: false) [$TRIVY_SKIP_UPDATE, $TRIVY_SKIP_DB_UPDATE]
+   --skip-policy-update                           skip updating built-in policies (default: false) [$TRIVY_SKIP_POLICY_UPDATE]
+   --clear-cache, -c                              clear image caches without scanning (default: false) [$TRIVY_CLEAR_CACHE]
+   --ignore-unfixed                               display only fixed vulnerabilities (default: false) [$TRIVY_IGNORE_UNFIXED]
+   --vuln-type value                              comma-separated list of vulnerability types (os,library) (default: "os,library") [$TRIVY_VULN_TYPE]
+   --security-checks value                        comma-separated list of what security issues to detect (vuln,config) (default: "vuln") [$TRIVY_SECURITY_CHECKS]
+   --ignorefile value                             specify .trivyignore file (default: ".trivyignore") [$TRIVY_IGNOREFILE]
+   --cache-backend value                          cache backend (e.g. redis://localhost:6379) (default: "fs") [$TRIVY_CACHE_BACKEND]
+   --timeout value                                timeout (default: 5m0s) [$TRIVY_TIMEOUT]
+   --no-progress                                  suppress progress bar (default: false) [$TRIVY_NO_PROGRESS]
+   --ignore-policy value                          specify the Rego file to evaluate each vulnerability [$TRIVY_IGNORE_POLICY]
+   --list-all-pkgs                                enabling the option will output all packages regardless of vulnerability (default: false) [$TRIVY_LIST_ALL_PKGS]
+   --offline-scan                                 do not issue API requests to identify dependencies (default: false) [$TRIVY_OFFLINE_SCAN]
+   --skip-files value                             specify the file paths to skip traversal [$TRIVY_SKIP_FILES]
+   --skip-dirs value                              specify the directories where the traversal is skipped [$TRIVY_SKIP_DIRS]
+   --config-policy value                          specify paths to the Rego policy files directory, applying config files [$TRIVY_CONFIG_POLICY]
+   --config-data value                            specify paths from which data for the Rego policies will be recursively loaded [$TRIVY_CONFIG_DATA]
+   --policy-namespaces value, --namespaces value  Rego namespaces (default: "users") [$TRIVY_POLICY_NAMESPACES]
+   --help, -h                                     show help (default: false)
+```

docs/getting-started/cli/image.md

@@ -27,6 +27,7 @@ OPTIONS:
    --light                     light mode: it's faster, but vulnerability descriptions and references are not displayed (default: false) [$TRIVY_LIGHT]
    --ignore-policy value       specify the Rego file to evaluate each vulnerability [$TRIVY_IGNORE_POLICY]
    --list-all-pkgs             enabling the option will output all packages regardless of vulnerability (default: false) [$TRIVY_LIST_ALL_PKGS]
+   --offline-scan              do not issue API requests to identify dependencies (default: false) [$TRIVY_OFFLINE_SCAN]
    --skip-files value          specify the file path to skip traversal [$TRIVY_SKIP_FILES]
    --skip-dirs value           specify the directory where the traversal is skipped [$TRIVY_SKIP_DIRS]
    --cache-backend value       cache backend (e.g. redis://localhost:6379) (default: "fs") [$TRIVY_CACHE_BACKEND]

docs/getting-started/cli/index.md

@@ -1,6 +1,6 @@
 Trivy has several sub commands, image, fs, repo, client and server.
 
-```
+``` bash
 NAME:
    trivy - A simple and comprehensive vulnerability scanner for containers
 
@@ -8,7 +8,7 @@ USAGE:
    trivy [global options] command [command options] target
 
 VERSION:
-   v0.15.0
+   dev
 
 COMMANDS:
    image, i          scan an image
@@ -16,6 +16,8 @@ COMMANDS:
    repository, repo  scan remote repository
    client, c         client mode
    server, s         server mode
+   config, conf      scan config files
+   plugin, p         manage plugins
    help, h           Shows a list of commands or help for one command
 
 GLOBAL OPTIONS:
@@ -24,4 +26,5 @@ GLOBAL OPTIONS:
    --cache-dir value  cache directory (default: "/Users/teppei/Library/Caches/trivy") [$TRIVY_CACHE_DIR]
    --help, -h         show help (default: false)
    --version, -v      print the version (default: false)
+
 ```

docs/getting-started/cli/repo.md

@@ -25,6 +25,7 @@ OPTIONS:
    --no-progress               suppress progress bar (default: false) [$TRIVY_NO_PROGRESS]
    --ignore-policy value       specify the Rego file to evaluate each vulnerability [$TRIVY_IGNORE_POLICY]
    --list-all-pkgs             enabling the option will output all packages regardless of vulnerability (default: false) [$TRIVY_LIST_ALL_PKGS]
+   --offline-scan              do not issue API requests to identify dependencies (default: false) [$TRIVY_OFFLINE_SCAN]
    --skip-files value          specify the file path to skip traversal [$TRIVY_SKIP_FILES]
    --skip-dirs value           specify the directory where the traversal is skipped [$TRIVY_SKIP_DIRS]
    --help, -h                  show help (default: false)

docs/getting-started/cli/rootfs.md

@@ -0,0 +1,35 @@
+# Rootfs
+
+```bash
+NAME:
+   trivy rootfs - scan rootfs
+
+USAGE:
+   trivy rootfs [command options] dir
+
+OPTIONS:
+   --template value, -t value                     output template [$TRIVY_TEMPLATE]
+   --format value, -f value                       format (table, json, template) (default: "table") [$TRIVY_FORMAT]
+   --severity value, -s value                     severities of vulnerabilities to be displayed (comma separated) (default: "UNKNOWN,LOW,MEDIUM,HIGH,CRITICAL") [$TRIVY_SEVERITY]
+   --output value, -o value                       output file name [$TRIVY_OUTPUT]
+   --exit-code value                              Exit code when vulnerabilities were found (default: 0) [$TRIVY_EXIT_CODE]
+   --skip-db-update, --skip-update                skip updating vulnerability database (default: false) [$TRIVY_SKIP_UPDATE, $TRIVY_SKIP_DB_UPDATE]
+   --skip-policy-update                           skip updating built-in policies (default: false) [$TRIVY_SKIP_POLICY_UPDATE]
+   --clear-cache, -c                              clear image caches without scanning (default: false) [$TRIVY_CLEAR_CACHE]
+   --ignore-unfixed                               display only fixed vulnerabilities (default: false) [$TRIVY_IGNORE_UNFIXED]
+   --vuln-type value                              comma-separated list of vulnerability types (os,library) (default: "os,library") [$TRIVY_VULN_TYPE]
+   --security-checks value                        comma-separated list of what security issues to detect (vuln,config) (default: "vuln") [$TRIVY_SECURITY_CHECKS]
+   --ignorefile value                             specify .trivyignore file (default: ".trivyignore") [$TRIVY_IGNOREFILE]
+   --cache-backend value                          cache backend (e.g. redis://localhost:6379) (default: "fs") [$TRIVY_CACHE_BACKEND]
+   --timeout value                                timeout (default: 5m0s) [$TRIVY_TIMEOUT]
+   --no-progress                                  suppress progress bar (default: false) [$TRIVY_NO_PROGRESS]
+   --ignore-policy value                          specify the Rego file to evaluate each vulnerability [$TRIVY_IGNORE_POLICY]
+   --list-all-pkgs                                enabling the option will output all packages regardless of vulnerability (default: false) [$TRIVY_LIST_ALL_PKGS]
+   --offline-scan                                 do not issue API requests to identify dependencies (default: false) [$TRIVY_OFFLINE_SCAN]
+   --skip-files value                             specify the file paths to skip traversal [$TRIVY_SKIP_FILES]
+   --skip-dirs value                              specify the directories where the traversal is skipped [$TRIVY_SKIP_DIRS]
+   --config-policy value                          specify paths to the Rego policy files directory, applying config files [$TRIVY_CONFIG_POLICY]
+   --config-data value                            specify paths from which data for the Rego policies will be recursively loaded [$TRIVY_CONFIG_DATA]
+   --policy-namespaces value, --namespaces value  Rego namespaces (default: "users") [$TRIVY_POLICY_NAMESPACES]
+   --help, -h                                     show help (default: false)
+```

docs/getting-started/credit.md

@@ -0,0 +1,10 @@
+# Author
+
+[Teppei Fukuda][knqyf263] (knqyf263)
+
+# Contributors
+
+Thanks to all [contributors][contributors]
+
+[knqyf263]: https://github.com/knqyf263
+[contributors]: https://github.com/aquasecurity/trivy/graphs/contributors

docs/getting-started/further.md

@@ -18,7 +18,6 @@
 - [Find Image Vulnerabilities Using GitHub and Aqua Security Trivy Action][actions2]
 - [Using Trivy to Discover Vulnerabilities in VS Code Projects][vscode]
 
-
 [intro]: https://www.youtube.com/watch?v=AzOBGm7XxOA
 [cncf]: https://www.youtube.com/watch?v=XnYxX9uueoQ
 [server]: https://www.youtube.com/watch?v=tNQ-VlahtYM

docs/getting-started/installation.md

@@ -2,56 +2,63 @@
 
 ## RHEL/CentOS
 
-Add repository setting to `/etc/yum.repos.d`.
 
-```bash
-$ sudo vim /etc/yum.repos.d/trivy.repo
-[trivy]
-name=Trivy repository
-baseurl=https://aquasecurity.github.io/trivy-repo/rpm/releases/$releasever/$basearch/
-gpgcheck=0
-enabled=1
-$ sudo yum -y update
-$ sudo yum -y install trivy
-```
+=== "Repository"
+    Add repository setting to `/etc/yum.repos.d`.
 
-or
+    ``` bash
+    $ sudo vim /etc/yum.repos.d/trivy.repo
+    [trivy]
+    name=Trivy repository
+    baseurl=https://aquasecurity.github.io/trivy-repo/rpm/releases/$releasever/$basearch/
+    gpgcheck=0
+    enabled=1
+    $ sudo yum -y update
+    $ sudo yum -y install trivy
+    ```
 
-```bash
-rpm -ivh https://github.com/aquasecurity/trivy/releases/download/{{ git.tag }}/trivy_{{ git.tag[1:] }}_Linux-64bit.rpm
-```
+=== "RPM"
+
+    ``` bash
+    rpm -ivh https://github.com/aquasecurity/trivy/releases/download/{{ git.tag }}/trivy_{{ git.tag[1:] }}_Linux-64bit.rpm
+    ```
 
 ## Debian/Ubuntu
 
-Add repository to `/etc/apt/sources.list.d`.
+=== "Repository"
+    Add repository setting to `/etc/apt/sources.list.d`.
 
-```bash
-sudo apt-get install wget apt-transport-https gnupg lsb-release
-wget -qO - https://aquasecurity.github.io/trivy-repo/deb/public.key | sudo apt-key add -
-echo deb https://aquasecurity.github.io/trivy-repo/deb $(lsb_release -sc) main | sudo tee -a /etc/apt/sources.list.d/trivy.list
-sudo apt-get update
-sudo apt-get install trivy
-```
+    ``` bash
+    sudo apt-get install wget apt-transport-https gnupg lsb-release
+    wget -qO - https://aquasecurity.github.io/trivy-repo/deb/public.key | sudo apt-key add -
+    echo deb https://aquasecurity.github.io/trivy-repo/deb $(lsb_release -sc) main | sudo tee -a /etc/apt/sources.list.d/trivy.list
+    sudo apt-get update
+    sudo apt-get install trivy
+    ```
 
-or
+=== "DEB"
 
-```bash
-wget https://github.com/aquasecurity/trivy/releases/download/{{ git.tag }}/trivy_{{ git.tag[1:] }}_Linux-64bit.deb
-sudo dpkg -i trivy_{{ git.tag[1:] }}_Linux-64bit.deb
-```
+    ``` bash
+    wget https://github.com/aquasecurity/trivy/releases/download/{{ git.tag }}/trivy_{{ git.tag[1:] }}_Linux-64bit.deb
+    sudo dpkg -i trivy_{{ git.tag[1:] }}_Linux-64bit.deb
+    ```
 
 
 
 ## Arch Linux
-Package trivy-bin can be installed from the Arch User Repository. Examples:
+Package trivy-bin can be installed from the Arch User Repository.
 
-```bash
-pikaur -Sy trivy-bin
-```
-or
-```bash
-yay -Sy trivy-bin
-```
+=== "pikaur"
+
+    ``` bash
+    pikaur -Sy trivy-bin
+    ```
+
+=== "yay"
+
+    ``` bash
+    yay -Sy trivy-bin
+    ```
 
 ## Homebrew
 
@@ -106,17 +113,20 @@ Replace [YOUR_CACHE_DIR] with the cache directory on your machine.
 docker pull aquasec/trivy:{{ git.tag[1:] }}
 ```
 
-Example for Linux:
+Example:
 
-```bash
-docker run --rm -v [YOUR_CACHE_DIR]:/root/.cache/ aquasec/trivy:{{ git.tag[1:] }} [YOUR_IMAGE_NAME]
-```
+=== "Linux"
 
-Example for macOS:
+    ``` bash
+    docker run --rm -v [YOUR_CACHE_DIR]:/root/.cache/ aquasec/trivy:{{ git.tag[1:] }} [YOUR_IMAGE_NAME]
+    ```
 
-```bash
-docker run --rm -v $HOME/Library/Caches:/root/.cache/ aquasec/trivy:{{ git.tag[1:] }} python:3.4-alpine
-```
+=== "macOS"
+
+    ``` bash
+    yay -Sy trivy-bin
+    docker run --rm -v $HOME/Library/Caches:/root/.cache/ aquasec/trivy:{{ git.tag[1:] }} python:3.4-alpine
+    ```
 
 If you would like to scan the image on your host machine, you need to mount `docker.sock`.
 
@@ -156,11 +166,10 @@ The same image is hosted on [GitHub Container Registry][registry] as well.
 docker pull ghcr.io/aquasecurity/trivy:{{ git.tag[1:] }}
 ```
 
-[registry]: https://github.com/orgs/aquasecurity/packages/container/package/trivy
 
 ### Amazon ECR Public
 
-The same image is hosted on [Amazon ECR Public](https://gallery.ecr.aws/aquasecurity/trivy) as well.
+The same image is hosted on [Amazon ECR Public][ecr] as well.
 
 ```bash
 docker pull public.ecr.aws/aquasecurity/trivy:{{ git.tag[1:] }}
@@ -183,7 +192,11 @@ To install the chart with the release name `my-release`:
 helm install my-release .
 ```
 
-The command deploys Trivy on the Kubernetes cluster in the default configuration. The [Parameters](#parameters)
+The command deploys Trivy on the Kubernetes cluster in the default configuration. The [Parameters][helm]
 section lists the parameters that can be configured during installation.
 
 > **Tip**: List all releases using `helm list`.
+
+[ecr]: https://gallery.ecr.aws/aquasecurity/trivy
+[registry]: https://github.com/orgs/aquasecurity/packages/container/package/trivy
+[helm]: https://github.com/aquasecurity/trivy/tree/{{ git.tag }}/helm/trivy

docs/getting-started/overview.md

@@ -0,0 +1,83 @@
+# Overview
+
+Trivy detects two types of security issues:
+
+- [Vulnerabilities][vuln]
+- [Misconfigurations][misconf]
+
+Trivy can scan three different artifacts:
+
+- [Container Images][container]
+- [Filesystem][filesystem] and [Rootfs][rootfs]
+- [Git Repositories][repo]
+
+Trivy can be run in two different modes:
+
+- [Standalone][standalone]
+- [Client/Server][client-server]
+
+It is designed to be used in CI. Before pushing to a container registry or deploying your application, you can scan your local container image and other artifacts easily.
+See [Integrations][integrations] for details.
+
+## Features
+
+- Comprehensive vulnerability detection
+    - [OS packages][os] (Alpine, Red Hat Universal Base Image, Red Hat Enterprise Linux, CentOS, Oracle Linux, Debian, Ubuntu, Amazon Linux, openSUSE Leap, SUSE Enterprise Linux, Photon OS and Distroless)
+    - [**Language-specific packages**][lang] (Bundler, Composer, Pipenv, Poetry, npm, yarn, Cargo, NuGet, Maven, and Go)
+- Detect IaC misconfigurations
+    - A wide variety of [built-in policies][builtin] are provided **out of the box**:
+        - Kubernetes
+        - Docker
+        - Terraform
+        - more coming soon
+    - Support custom policies
+- Simple
+    - Specify only an image name, a directory containing IaC configs, or an artifact name
+    - See [Quick Start][quickstart]
+- Fast
+    - The first scan will finish within 10 seconds (depending on your network). Consequent scans will finish in single seconds.
+    - Unlike other scanners that take long to fetch vulnerability information (~10 minutes) on the first run, and encourage you to maintain a durable vulnerability database, Trivy is stateless and requires no maintenance or preparation.
+- Easy installation
+    - `apt-get install`, `yum install` and `brew install` is possible (See [Installation](installation.md))
+    - **No pre-requisites** such as installation of DB, libraries, etc.
+- High accuracy
+    - **Especially Alpine Linux and RHEL/CentOS**
+    - Other OSes are also high
+- DevSecOps
+    - **Suitable for CI** such as Travis CI, CircleCI, Jenkins, GitLab CI, etc.
+    - See [CI Example][integrations]
+- Support multiple formats
+    - container image
+        - A local image in Docker Engine which is running as a daemon
+        - A local image in [Podman][podman] (>=2.0) which is exposing a socket
+        - A remote image in Docker Registry such as Docker Hub, ECR, GCR and ACR
+        - A tar archive stored in the `docker save` / `podman save` formatted file
+        - An image directory compliant with [OCI Image Format][oci]
+    - local filesystem and rootfs
+    - remote git repository
+
+Please see [LICENSE][license] for Trivy licensing information.
+
+!!! note
+    Trivy uses vulnerability information from a variety of sources, some of which are licensed for non-commercial use only.
+
+[vuln]: ../vulnerability/scanning/index.md
+[misconf]: ../misconfiguration/index.md
+[container]: ../vulnerability/scanning/image.md
+[rootfs]: ../vulnerability/scanning/rootfs.md
+[filesystem]: ../vulnerability/scanning/filesystem.md
+[repo]: ../vulnerability/scanning/git-repository.md
+
+[standalone]: ../advanced/modes/standalone.md
+[client-server]: ../advanced/modes/client-server.md
+[integrations]: ../advanced/integrations/index.md
+
+[os]: ../vulnerability/detection/os.md
+[lang]: ../vulnerability/detection/language.md
+
+[builtin]: ../misconfiguration/policy/builtin.md
+[quickstart]: quickstart.md
+[podman]: ../advanced/container/podman.md
+
+[oci]: https://github.com/opencontainers/image-spec
+[license]:  https://github.com/aquasecurity/trivy/blob/main/LICENSE

docs/getting-started/quickstart.md

@@ -0,0 +1,83 @@
+# Quick Start
+
+## Scan image for vulnerabilities
+
+Simply specify an image name (and a tag).
+
+```
+$ trivy image [YOUR_IMAGE_NAME]
+```
+
+For example:
+
+```
+$ trivy image python:3.4-alpine
+```
+
+<details>
+<summary>Result</summary>
+
+```
+2019-05-16T01:20:43.180+0900    INFO    Updating vulnerability database...
+2019-05-16T01:20:53.029+0900    INFO    Detecting Alpine vulnerabilities...
+
+python:3.4-alpine3.9 (alpine 3.9.2)
+===================================
+Total: 1 (UNKNOWN: 0, LOW: 0, MEDIUM: 1, HIGH: 0, CRITICAL: 0)
+
++---------+------------------+----------+-------------------+---------------+--------------------------------+
+| LIBRARY | VULNERABILITY ID | SEVERITY | INSTALLED VERSION | FIXED VERSION |             TITLE              |
++---------+------------------+----------+-------------------+---------------+--------------------------------+
+| openssl | CVE-2019-1543    | MEDIUM   | 1.1.1a-r1         | 1.1.1b-r1     | openssl: ChaCha20-Poly1305     |
+|         |                  |          |                   |               | with long nonces               |
++---------+------------------+----------+-------------------+---------------+--------------------------------+
+```
+
+</details>
+
+For more details, see [here][vulnerability].
+
+## Scan directory for misconfigurations
+
+Simply specify a directory containing IaC files such as Terraform and Dockerfile.
+
+```
+$ trivy config [YOUR_IAC_DIR]
+```
+
+For example:
+
+```
+$ ls build/
+Dockerfile
+$ trivy config ./build
+```
+
+<details>
+<summary>Result</summary>
+
+```
+2021-07-09T10:06:29.188+0300    INFO    Need to update the built-in policies
+2021-07-09T10:06:29.188+0300    INFO    Downloading the built-in policies...
+2021-07-09T10:06:30.520+0300    INFO    Detected config files: 1
+
+Dockerfile (dockerfile)
+=======================
+Tests: 23 (SUCCESSES: 22, FAILURES: 1, EXCEPTIONS: 0)
+Failures: 1 (UNKNOWN: 0, LOW: 0, MEDIUM: 0, HIGH: 1, CRITICAL: 0)
+
++---------------------------+------------+----------------------+----------+------------------------------------------+
+|           TYPE            | MISCONF ID |        CHECK         | SEVERITY |                 MESSAGE                  |
++---------------------------+------------+----------------------+----------+------------------------------------------+
+| Dockerfile Security Check |   DS002    | Image user is 'root' |   HIGH   | Last USER command in                     |
+|                           |            |                      |          | Dockerfile should not be 'root'          |
+|                           |            |                      |          | -->avd.aquasec.com/appshield/ds002       |
++---------------------------+------------+----------------------+----------+------------------------------------------+
+```
+
+</details>
+
+For more details, see [here][misconf].
+
+[vulnerability]: ../vulnerability/scanning/index.md
+[misconf]: ../misconfiguration/index.md

docs/getting-started/troubleshooting.md

@@ -1,11 +1,84 @@
-# FAQ
+# Troubleshooting
 
 ## Scan
-### analyze error: timeout: context deadline exceeded
+### Timeout
+
+!!! error
+    ``` bash
+    $ trivy image ...
+    ...
+    analyze error: timeout: context deadline exceeded
+    ```
+
 Your scan may time out. Java takes a particularly long time to scan. Try increasing the value of the ---timeout option such as `--timeout 15m`.
 
+### Certification
+
+!!! error
+    Error: x509: certificate signed by unknown authority
+
+`TRIVY_INSECURE` can be used to allow insecure connections to a container registry when using SSL.
+
+```
+$ TRIVY_INSECURE=true trivy image [YOUR_IMAGE]
+```
+
+### GitHub Rate limiting
+
+!!! error
+    ``` bash
+    $ trivy image ...
+    ...
+    API rate limit exceeded for xxx.xxx.xxx.xxx.
+    ```
+
+Specify GITHUB_TOKEN for authentication
+https://developer.github.com/v3/#rate-limiting
+
+```
+$ GITHUB_TOKEN=XXXXXXXXXX trivy alpine:3.10
+```
+
+### Maven rate limiting
+
+!!! error
+    ``` bash
+    $ trivy image ...
+    ...
+    status 403 Forbidden from http://search.maven.org/solrsearch/select
+    ```
+
+Trivy calls Maven API for better detection of JAR files, but many requests may exceed rate limiting.
+If it happens frequently, try the `--offline-scan` option to stop Trivy from making API requests.
+This option affects only vulnerability scanning. The vulnerability database and builtin policies are downloaded as usual.
+If you want to skip them as well, you can try `--skip-update` and `--skip-policy-update`.
+
+Note that a number of vulnerabilities might be fewer than without the `--offline-scan` option.
+
+### Running in parallel takes same time as series run
+When running trivy on multiple images simultaneously, it will take same time as running trivy in series.  
+This is because of a limitation of boltdb.
+> Bolt obtains a file lock on the data file so multiple processes cannot open the same database at the same time. Opening an already open Bolt database will cause it to hang until the other process closes it.
+
+Reference : [boltdb: Opening a database][boltdb].
+
+[boltdb]: https://github.com/boltdb/bolt#opening-a-database
+
+### Error downloading vulnerability DB
+
+!!! error
+    FATAL failed to download vulnerability DB
+
+If trivy is running behind corporate firewall try to whitelist urls below:
+
+- api.github.com
+- github.com
+- github-releases.githubusercontent.com
+
 ## Homebrew
-### Error: Your macOS keychain GitHub credentials do not have sufficient scope!
+### Scope error
+!!! error
+    Error: Your macOS keychain GitHub credentials do not have sufficient scope!
 
 ```
 $ brew tap aquasecurity/trivy
@@ -23,7 +96,9 @@ Try:
 $ printf "protocol=https\nhost=github.com\n" | git credential-osxkeychain erase
 ```
 
-### Error: aquasecurity/trivy/trivy 64 already installed
+### Already installed
+!!! error
+    Error: aquasecurity/trivy/trivy 64 already installed
 
 ```
 $ brew upgrade
@@ -39,31 +114,8 @@ $ brew unlink trivy && brew uninstall trivy
 $ brew install aquasecurity/trivy/trivy
 ```
 
-### Error: x509: certificate signed by unknown authority
-`TRIVY_INSECURE` can be used to allow insecure connections to a container registry when using SSL.
-
-```
-$ TRIVY_INSECURE=true trivy image [YOUR_IMAGE]
-```
-
-### Running in parallel takes same time as series run
-When running trivy on multiple images simultaneously, it will take same time as running trivy in series.  
-This is because of a limitation of boltdb.
-> Bolt obtains a file lock on the data file so multiple processes cannot open the same database at the same time. Opening an already open Bolt database will cause it to hang until the other process closes it.
-Reference : [boltdb: Opening a database][boltdb].
-
-[boltdb]: https://github.com/boltdb/bolt#opening-a-database
 
 ## Others
-### GitHub Rate limiting
-
-Specify GITHUB_TOKEN for authentication
-https://developer.github.com/v3/#rate-limiting
-
-```
-$ GITHUB_TOKEN=XXXXXXXXXX trivy alpine:3.10
-```
-
 ### Unknown error
 
 Try again with `--reset` option:

docs/imgs/excalidraw/misconf.excalidraw

@@ -0,0 +1,352 @@
+{
+  "type": "excalidraw",
+  "version": 2,
+  "source": "https://excalidraw.com",
+  "elements": [
+    {
+      "type": "rectangle",
+      "version": 573,
+      "versionNonce": 2034670720,
+      "isDeleted": false,
+      "id": "BkXuq_6BxgqZGZWc8oCtu",
+      "fillStyle": "hachure",
+      "strokeWidth": 1,
+      "strokeStyle": "solid",
+      "roughness": 1,
+      "opacity": 100,
+      "angle": 0,
+      "x": 599.211669921875,
+      "y": 376.32061767578125,
+      "strokeColor": "#000000",
+      "backgroundColor": "#fd7e14",
+      "width": 867.8921508789062,
+      "height": 151.39703369140625,
+      "seed": 1632394695,
+      "groupIds": [],
+      "strokeSharpness": "sharp",
+      "boundElementIds": []
+    },
+    {
+      "type": "text",
+      "version": 572,
+      "versionNonce": 425683840,
+      "isDeleted": false,
+      "id": "YQURTHNPSe05RPSlYRcok",
+      "fillStyle": "hachure",
+      "strokeWidth": 1,
+      "strokeStyle": "solid",
+      "roughness": 1,
+      "opacity": 100,
+      "angle": 0,
+      "x": 983.89404296875,
+      "y": 399.98724365234375,
+      "strokeColor": "#000000",
+      "backgroundColor": "transparent",
+      "width": 88,
+      "height": 45,
+      "seed": 891391049,
+      "groupIds": [],
+      "strokeSharpness": "sharp",
+      "boundElementIds": [],
+      "fontSize": 36,
+      "fontFamily": 1,
+      "text": "Trivy",
+      "baseline": 32,
+      "textAlign": "left",
+      "verticalAlign": "top"
+    },
+    {
+      "type": "text",
+      "version": 822,
+      "versionNonce": 1061096576,
+      "isDeleted": false,
+      "id": "6dpF2EyZBtYgO6MrvGj0-",
+      "fillStyle": "hachure",
+      "strokeWidth": 1,
+      "strokeStyle": "solid",
+      "roughness": 1,
+      "opacity": 100,
+      "angle": 0,
+      "x": 771.2554931640625,
+      "y": 469.7777099609375,
+      "strokeColor": "#000000",
+      "backgroundColor": "transparent",
+      "width": 507,
+      "height": 35,
+      "seed": 687997545,
+      "groupIds": [],
+      "strokeSharpness": "sharp",
+      "boundElementIds": [],
+      "fontSize": 28,
+      "fontFamily": 1,
+      "text": "Vulnerability/Misconfiguration Scanner",
+      "baseline": 25,
+      "textAlign": "left",
+      "verticalAlign": "top"
+    },
+    {
+      "type": "rectangle",
+      "version": 763,
+      "versionNonce": 560331648,
+      "isDeleted": false,
+      "id": "cpnTMy7L2AUg9IDJppF4H",
+      "fillStyle": "hachure",
+      "strokeWidth": 1,
+      "strokeStyle": "solid",
+      "roughness": 1,
+      "opacity": 100,
+      "angle": 0,
+      "x": 602.28369140625,
+      "y": 258.8445587158203,
+      "strokeColor": "#000000",
+      "backgroundColor": "#fab005",
+      "width": 397.493408203125,
+      "height": 103.28388977050778,
+      "seed": 77164935,
+      "groupIds": [],
+      "strokeSharpness": "sharp",
+      "boundElementIds": []
+    },
+    {
+      "type": "text",
+      "version": 1072,
+      "versionNonce": 212434048,
+      "isDeleted": false,
+      "id": "9-blmNVtLesthMSY_f60t",
+      "fillStyle": "hachure",
+      "strokeWidth": 1,
+      "strokeStyle": "solid",
+      "roughness": 1,
+      "opacity": 100,
+      "angle": 0,
+      "x": 630.9301147460938,
+      "y": 292.4002990722656,
+      "strokeColor": "#000000",
+      "backgroundColor": "transparent",
+      "width": 331,
+      "height": 35,
+      "seed": 860091815,
+      "groupIds": [],
+      "strokeSharpness": "sharp",
+      "boundElementIds": [],
+      "fontSize": 28,
+      "fontFamily": 1,
+      "text": "Infrastructure as Code",
+      "baseline": 25,
+      "textAlign": "center",
+      "verticalAlign": "top"
+    },
+    {
+      "type": "rectangle",
+      "version": 1194,
+      "versionNonce": 131337088,
+      "isDeleted": false,
+      "id": "gugZxhi7ThlcjWY_MFO7q",
+      "fillStyle": "hachure",
+      "strokeWidth": 1,
+      "strokeStyle": "solid",
+      "roughness": 1,
+      "opacity": 100,
+      "angle": 0,
+      "x": 1021.5928955078125,
+      "y": 261.56090545654297,
+      "strokeColor": "#000000",
+      "backgroundColor": "#be4bdb",
+      "width": 441.0702514648438,
+      "height": 99.05134582519533,
+      "seed": 1232790121,
+      "groupIds": [],
+      "strokeSharpness": "sharp",
+      "boundElementIds": []
+    },
+    {
+      "type": "text",
+      "version": 1270,
+      "versionNonce": 591785088,
+      "isDeleted": false,
+      "id": "K48gtpesBxIGJxLTnI2CB",
+      "fillStyle": "hachure",
+      "strokeWidth": 1,
+      "strokeStyle": "solid",
+      "roughness": 1,
+      "opacity": 100,
+      "angle": 0,
+      "x": 1173.3179931640625,
+      "y": 294.12510681152344,
+      "strokeColor": "#000000",
+      "backgroundColor": "transparent",
+      "width": 137,
+      "height": 35,
+      "seed": 449264361,
+      "groupIds": [],
+      "strokeSharpness": "sharp",
+      "boundElementIds": [],
+      "fontSize": 28,
+      "fontFamily": 1,
+      "text": "Filesystem",
+      "baseline": 25,
+      "textAlign": "center",
+      "verticalAlign": "top"
+    },
+    {
+      "type": "rectangle",
+      "version": 1319,
+      "versionNonce": 1264839808,
+      "isDeleted": false,
+      "id": "BYJwfkhd1BilbLQGc973f",
+      "fillStyle": "hachure",
+      "strokeWidth": 1,
+      "strokeStyle": "solid",
+      "roughness": 1,
+      "opacity": 100,
+      "angle": 0,
+      "x": 1233.3157348632812,
+      "y": 168.29967880249023,
+      "strokeColor": "#000000",
+      "backgroundColor": "#82c91e",
+      "width": 229.03393554687523,
+      "height": 77.80606079101562,
+      "seed": 1923498546,
+      "groupIds": [],
+      "strokeSharpness": "sharp",
+      "boundElementIds": []
+    },
+    {
+      "type": "text",
+      "version": 659,
+      "versionNonce": 2122259328,
+      "isDeleted": false,
+      "id": "eedUyCpr8i1aY_3PHsHAB",
+      "fillStyle": "hachure",
+      "strokeWidth": 1,
+      "strokeStyle": "solid",
+      "roughness": 1,
+      "opacity": 100,
+      "angle": 0,
+      "x": 1241.1352844238281,
+      "y": 191.2939567565918,
+      "strokeColor": "#000000",
+      "backgroundColor": "#82c91e",
+      "width": 216,
+      "height": 35,
+      "seed": 595309038,
+      "groupIds": [],
+      "strokeSharpness": "sharp",
+      "boundElementIds": [],
+      "fontSize": 28,
+      "fontFamily": 1,
+      "text": "Misconfiguration",
+      "baseline": 25,
+      "textAlign": "center",
+      "verticalAlign": "middle"
+    },
+    {
+      "type": "rectangle",
+      "version": 1397,
+      "versionNonce": 20077696,
+      "isDeleted": false,
+      "id": "SPkrBrH6DGvkgQXtZQjIJ",
+      "fillStyle": "hachure",
+      "strokeWidth": 1,
+      "strokeStyle": "solid",
+      "roughness": 1,
+      "opacity": 100,
+      "angle": 0,
+      "x": 1023.8157043457031,
+      "y": 168.7816276550293,
+      "strokeColor": "#000000",
+      "backgroundColor": "#fa5252",
+      "width": 200.7496337890626,
+      "height": 77.80606079101562,
+      "seed": 1896460914,
+      "groupIds": [],
+      "strokeSharpness": "sharp",
+      "boundElementIds": []
+    },
+    {
+      "type": "text",
+      "version": 840,
+      "versionNonce": 655338368,
+      "isDeleted": false,
+      "id": "n06MNIqirDmVZBkDg_UPV",
+      "fillStyle": "hachure",
+      "strokeWidth": 1,
+      "strokeStyle": "solid",
+      "roughness": 1,
+      "opacity": 100,
+      "angle": 0,
+      "x": 1040.526611328125,
+      "y": 194.3111228942871,
+      "strokeColor": "#000000",
+      "backgroundColor": "#82c91e",
+      "width": 160,
+      "height": 35,
+      "seed": 1131832750,
+      "groupIds": [],
+      "strokeSharpness": "sharp",
+      "boundElementIds": [],
+      "fontSize": 28,
+      "fontFamily": 1,
+      "text": "Vulnerability",
+      "baseline": 25,
+      "textAlign": "center",
+      "verticalAlign": "middle"
+    },
+    {
+      "type": "rectangle",
+      "version": 1441,
+      "versionNonce": 1393118080,
+      "isDeleted": false,
+      "id": "8SHSNGf7PNddFLi2ZA3Vi",
+      "fillStyle": "hachure",
+      "strokeWidth": 1,
+      "strokeStyle": "solid",
+      "roughness": 1,
+      "opacity": 100,
+      "angle": 0,
+      "x": 673.6463928222656,
+      "y": 167.8159294128418,
+      "strokeColor": "#000000",
+      "backgroundColor": "#82c91e",
+      "width": 278.48516845703136,
+      "height": 77.80606079101562,
+      "seed": 1986948530,
+      "groupIds": [],
+      "strokeSharpness": "sharp",
+      "boundElementIds": []
+    },
+    {
+      "type": "text",
+      "version": 851,
+      "versionNonce": 2114620544,
+      "isDeleted": false,
+      "id": "3Z5w3RXdgpvP43dlHqq26",
+      "fillStyle": "hachure",
+      "strokeWidth": 1,
+      "strokeStyle": "solid",
+      "roughness": 1,
+      "opacity": 100,
+      "angle": 0,
+      "x": 701.5146789550781,
+      "y": 189.60757064819336,
+      "strokeColor": "#000000",
+      "backgroundColor": "#82c91e",
+      "width": 216,
+      "height": 35,
+      "seed": 1077804654,
+      "groupIds": [],
+      "strokeSharpness": "sharp",
+      "boundElementIds": [],
+      "fontSize": 28,
+      "fontFamily": 1,
+      "text": "Misconfiguration",
+      "baseline": 25,
+      "textAlign": "center",
+      "verticalAlign": "middle"
+    }
+  ],
+  "appState": {
+    "gridSize": null,
+    "viewBackgroundColor": "#ffffff"
+  }
+}

docs/imgs/excalidraw/overview.excalidraw

@@ -5,31 +5,8 @@
   "elements": [
     {
       "type": "rectangle",
-      "version": 560,
-      "versionNonce": 1400582380,
-      "isDeleted": false,
-      "id": "zULZ64ij5HLsp2cFZILSX",
-      "fillStyle": "hachure",
-      "strokeWidth": 1,
-      "strokeStyle": "solid",
-      "roughness": 1,
-      "opacity": 50,
-      "angle": 0,
-      "x": 904.2628784179688,
-      "y": 99.2658462524414,
-      "strokeColor": "#000000",
-      "backgroundColor": "#15aabf",
-      "width": 130.58160400390628,
-      "height": 79.7976837158203,
-      "seed": 1174361836,
-      "groupIds": [],
-      "strokeSharpness": "sharp",
-      "boundElementIds": []
-    },
-    {
-      "type": "rectangle",
-      "version": 283,
-      "versionNonce": 431858644,
+      "version": 476,
+      "versionNonce": 916788210,
       "isDeleted": false,
       "id": "BkXuq_6BxgqZGZWc8oCtu",
       "fillStyle": "hachure",
@@ -38,11 +15,11 @@
       "roughness": 1,
       "opacity": 100,
       "angle": 0,
-      "x": 760.100830078125,
+      "x": 599.211669921875,
       "y": 376.32061767578125,
       "strokeColor": "#000000",
       "backgroundColor": "#fd7e14",
-      "width": 792.3008422851561,
+      "width": 1076.4584350585938,
       "height": 151.39703369140625,
       "seed": 1632394695,
       "groupIds": [],
@@ -51,8 +28,8 @@
     },
     {
       "type": "text",
-      "version": 217,
-      "versionNonce": 605539564,
+      "version": 423,
+      "versionNonce": 931200686,
       "isDeleted": false,
       "id": "YQURTHNPSe05RPSlYRcok",
       "fillStyle": "hachure",
@@ -61,12 +38,12 @@
       "roughness": 1,
       "opacity": 100,
       "angle": 0,
-      "x": 1106.6643676757812,
-      "y": 411.25714111328125,
+      "x": 1119.1937866210938,
+      "y": 403.56756591796875,
       "strokeColor": "#000000",
       "backgroundColor": "transparent",
-      "width": 86,
-      "height": 46,
+      "width": 88,
+      "height": 45,
       "seed": 891391049,
       "groupIds": [],
       "strokeSharpness": "sharp",
@@ -80,8 +57,8 @@
     },
     {
       "type": "text",
-      "version": 222,
-      "versionNonce": 1855404140,
+      "version": 758,
+      "versionNonce": 813811122,
       "isDeleted": false,
       "id": "6dpF2EyZBtYgO6MrvGj0-",
       "fillStyle": "hachure",
@@ -90,27 +67,27 @@
       "roughness": 1,
       "opacity": 100,
       "angle": 0,
-      "x": 941.25830078125,
-      "y": 471.68231201171875,
+      "x": 922.1328735351562,
+      "y": 470.18975830078125,
       "strokeColor": "#000000",
       "backgroundColor": "transparent",
-      "width": 474,
-      "height": 25,
+      "width": 507,
+      "height": 35,
       "seed": 687997545,
       "groupIds": [],
       "strokeSharpness": "sharp",
       "boundElementIds": [],
-      "fontSize": 20,
+      "fontSize": 28,
       "fontFamily": 1,
-      "text": "A Simple and Comprehensive Vulnerability Scanner",
-      "baseline": 18,
+      "text": "Vulnerability/Misconfiguration Scanner",
+      "baseline": 25,
       "textAlign": "left",
       "verticalAlign": "top"
     },
     {
       "type": "rectangle",
-      "version": 297,
-      "versionNonce": 239159404,
+      "version": 595,
+      "versionNonce": 1705780846,
       "isDeleted": false,
       "id": "cpnTMy7L2AUg9IDJppF4H",
       "fillStyle": "hachure",
@@ -119,12 +96,12 @@
       "roughness": 1,
       "opacity": 100,
       "angle": 0,
-      "x": 759.0067749023438,
-      "y": 192.9658660888672,
+      "x": 597.4796142578125,
+      "y": 258.9286651611328,
       "strokeColor": "#000000",
-      "backgroundColor": "#fa5252",
-      "width": 283.0587768554687,
-      "height": 79.7976837158203,
+      "backgroundColor": "#fab005",
+      "width": 349.1224975585937,
+      "height": 103.28388977050778,
       "seed": 77164935,
       "groupIds": [],
       "strokeSharpness": "sharp",
@@ -132,8 +109,8 @@
     },
     {
       "type": "text",
-      "version": 527,
-      "versionNonce": 1738982484,
+      "version": 921,
+      "versionNonce": 929185650,
       "isDeleted": false,
       "id": "9-blmNVtLesthMSY_f60t",
       "fillStyle": "hachure",
@@ -142,27 +119,27 @@
       "roughness": 1,
       "opacity": 100,
       "angle": 0,
-      "x": 851.9727783203125,
-      "y": 206.49542236328125,
+      "x": 655.6057739257812,
+      "y": 292.4844055175781,
       "strokeColor": "#000000",
       "backgroundColor": "transparent",
-      "width": 94,
-      "height": 50,
+      "width": 238,
+      "height": 35,
       "seed": 860091815,
       "groupIds": [],
       "strokeSharpness": "sharp",
       "boundElementIds": [],
-      "fontSize": 20,
+      "fontSize": 28,
       "fontFamily": 1,
-      "text": "Container\nImages",
-      "baseline": 43,
+      "text": "Container Images",
+      "baseline": 25,
       "textAlign": "center",
       "verticalAlign": "top"
     },
     {
       "type": "rectangle",
-      "version": 475,
-      "versionNonce": 1582652140,
+      "version": 853,
+      "versionNonce": 377039022,
       "isDeleted": false,
       "id": "gugZxhi7ThlcjWY_MFO7q",
       "fillStyle": "hachure",
@@ -171,12 +148,12 @@
       "roughness": 1,
       "opacity": 100,
       "angle": 0,
-      "x": 1052.2297973632812,
-      "y": 191.91817474365234,
+      "x": 955.929443359375,
+      "y": 262.11351776123047,
       "strokeColor": "#000000",
       "backgroundColor": "#be4bdb",
-      "width": 272.31054687500006,
-      "height": 79.7976837158203,
+      "width": 359.85211181640625,
+      "height": 99.05134582519533,
       "seed": 1232790121,
       "groupIds": [],
       "strokeSharpness": "sharp",
@@ -184,8 +161,8 @@
     },
     {
       "type": "text",
-      "version": 705,
-      "versionNonce": 1618155988,
+      "version": 1065,
+      "versionNonce": 126714162,
       "isDeleted": false,
       "id": "K48gtpesBxIGJxLTnI2CB",
       "fillStyle": "hachure",
@@ -194,27 +171,27 @@
       "roughness": 1,
       "opacity": 100,
       "angle": 0,
-      "x": 1137.923828125,
-      "y": 218.9615020751953,
+      "x": 1064.449462890625,
+      "y": 296.9230194091797,
       "strokeColor": "#000000",
       "backgroundColor": "transparent",
-      "width": 98,
-      "height": 25,
+      "width": 137,
+      "height": 35,
       "seed": 449264361,
       "groupIds": [],
       "strokeSharpness": "sharp",
       "boundElementIds": [],
-      "fontSize": 20,
+      "fontSize": 28,
       "fontFamily": 1,
       "text": "Filesystem",
-      "baseline": 18,
+      "baseline": 25,
       "textAlign": "center",
       "verticalAlign": "top"
     },
     {
       "type": "rectangle",
-      "version": 509,
-      "versionNonce": 1528748884,
+      "version": 896,
+      "versionNonce": 585884398,
       "isDeleted": false,
       "id": "La6f87LDZ0uEIZB947bXo",
       "fillStyle": "hachure",
@@ -223,12 +200,12 @@
       "roughness": 1,
       "opacity": 100,
       "angle": 0,
-      "x": 1342.2451782226562,
-      "y": 190.3844223022461,
+      "x": 1329.0839233398438,
+      "y": 264.9097213745117,
       "strokeColor": "#000000",
       "backgroundColor": "#12b886",
-      "width": 202.7937011718749,
-      "height": 79.7976837158203,
+      "width": 346.5517578125,
+      "height": 96.3990020751953,
       "seed": 2005637801,
       "groupIds": [],
       "strokeSharpness": "sharp",
@@ -236,8 +213,8 @@
     },
     {
       "type": "text",
-      "version": 866,
-      "versionNonce": 27928788,
+      "version": 1186,
+      "versionNonce": 1013615346,
       "isDeleted": false,
       "id": "aOgRPVQ81jhOfkvzjWTMF",
       "fillStyle": "hachure",
@@ -246,450 +223,282 @@
       "roughness": 1,
       "opacity": 100,
       "angle": 0,
-      "x": 1380.880859375,
-      "y": 202.2483367919922,
+      "x": 1392.300048828125,
+      "y": 294.1288604736328,
       "strokeColor": "#000000",
       "backgroundColor": "transparent",
-      "width": 122,
-      "height": 50,
+      "width": 223,
+      "height": 35,
       "seed": 1284472935,
       "groupIds": [],
       "strokeSharpness": "sharp",
       "boundElementIds": [],
-      "fontSize": 20,
+      "fontSize": 28,
       "fontFamily": 1,
-      "text": "Git\nRepositories",
-      "baseline": 43,
+      "text": "Git Repositories",
+      "baseline": 25,
       "textAlign": "center",
       "verticalAlign": "top"
     },
-    {
-      "type": "text",
-      "version": 247,
-      "versionNonce": 653112532,
-      "isDeleted": false,
-      "id": "p_mUPP7FjgXD4cyuwbbDb",
-      "fillStyle": "hachure",
-      "strokeWidth": 1,
-      "strokeStyle": "solid",
-      "roughness": 1,
-      "opacity": 100,
-      "angle": 0,
-      "x": 918.9429321289062,
-      "y": 104.1267318725586,
-      "strokeColor": "#000000",
-      "backgroundColor": "transparent",
-      "width": 106,
-      "height": 80,
-      "seed": 2021123719,
-      "groupIds": [],
-      "strokeSharpness": "sharp",
-      "boundElementIds": [],
-      "fontSize": 16,
-      "fontFamily": 1,
-      "text": "Programming\nLanguage\nDependencies\n",
-      "baseline": 75,
-      "textAlign": "center",
-      "verticalAlign": "middle"
-    },
     {
       "type": "rectangle",
-      "version": 223,
-      "versionNonce": 1335079532,
+      "version": 974,
+      "versionNonce": 1011959534,
       "isDeleted": false,
-      "id": "JPMgfRuI6H4FPW8-vegMJ",
+      "id": "BYJwfkhd1BilbLQGc973f",
       "fillStyle": "hachure",
       "strokeWidth": 1,
       "strokeStyle": "solid",
       "roughness": 1,
       "opacity": 100,
       "angle": 0,
-      "x": 759.9201354980469,
-      "y": 286.07564544677734,
+      "x": 1141.5093994140625,
+      "y": 171.09759140014648,
       "strokeColor": "#000000",
-      "backgroundColor": "#868e96",
-      "width": 157.08227539062494,
-      "height": 79.7976837158203,
-      "seed": 1163532908,
+      "backgroundColor": "#82c91e",
+      "width": 169.93957519531259,
+      "height": 77.80606079101562,
+      "seed": 1923498546,
       "groupIds": [],
       "strokeSharpness": "sharp",
       "boundElementIds": []
     },
     {
-      "id": "i6l1cTY8BN5dM9gV3TY1q",
       "type": "text",
-      "x": 774.47998046875,
-      "y": 303.88873291015625,
-      "width": 127,
-      "height": 50,
-      "angle": 0,
-      "strokeColor": "#000000",
-      "backgroundColor": "transparent",
-      "fillStyle": "hachure",
-      "strokeWidth": 1,
-      "strokeStyle": "solid",
-      "roughness": 1,
-      "opacity": 100,
-      "groupIds": [],
-      "strokeSharpness": "sharp",
-      "seed": 1614647380,
-      "version": 88,
-      "versionNonce": 1787296340,
+      "version": 403,
+      "versionNonce": 1635608306,
       "isDeleted": false,
-      "boundElementIds": null,
-      "text": "Client/Server\nMode",
-      "fontSize": 20,
-      "fontFamily": 1,
-      "textAlign": "center",
-      "verticalAlign": "top",
-      "baseline": 43
-    },
-    {
-      "type": "rectangle",
-      "version": 298,
-      "versionNonce": 1573553388,
-      "isDeleted": false,
-      "id": "zmjzAP9R7DY9tKjqvFBoB",
+      "id": "eedUyCpr8i1aY_3PHsHAB",
       "fillStyle": "hachure",
       "strokeWidth": 1,
       "strokeStyle": "solid",
       "roughness": 1,
       "opacity": 100,
       "angle": 0,
-      "x": 927.6312561035156,
-      "y": 285.23946380615234,
+      "x": 1149.8379821777344,
+      "y": 197.31159591674805,
       "strokeColor": "#000000",
-      "backgroundColor": "#ced4da",
-      "width": 621.8212890625001,
-      "height": 79.7976837158203,
-      "seed": 1660611796,
-      "groupIds": [],
-      "strokeSharpness": "sharp",
-      "boundElementIds": []
-    },
-    {
-      "id": "cvVouJIyT22r3RP8klygl",
-      "type": "text",
-      "x": 1137.06494140625,
-      "y": 312.9378967285156,
-      "width": 164,
+      "backgroundColor": "#82c91e",
+      "width": 155,
       "height": 25,
-      "angle": 0,
-      "strokeColor": "#000000",
-      "backgroundColor": "transparent",
-      "fillStyle": "hachure",
-      "strokeWidth": 1,
-      "strokeStyle": "solid",
-      "roughness": 1,
-      "opacity": 100,
-      "groupIds": [],
-      "strokeSharpness": "sharp",
-      "seed": 1325348180,
-      "version": 130,
-      "versionNonce": 498962388,
-      "isDeleted": false,
-      "boundElementIds": null,
-      "text": "Standalone Mode",
-      "fontSize": 20,
-      "fontFamily": 1,
-      "textAlign": "left",
-      "verticalAlign": "top",
-      "baseline": 18
-    },
-    {
-      "type": "rectangle",
-      "version": 452,
-      "versionNonce": 1384318828,
-      "isDeleted": false,
-      "id": "uZJjI0NYZ64gKin-_7cR5",
-      "fillStyle": "hachure",
-      "strokeWidth": 1,
-      "strokeStyle": "solid",
-      "roughness": 1,
-      "opacity": 100,
-      "angle": 0,
-      "x": 761.1866760253906,
-      "y": 100.00330352783203,
-      "strokeColor": "#000000",
-      "backgroundColor": "#4c6ef5",
-      "width": 128.17041015625003,
-      "height": 79.7976837158203,
-      "seed": 401388012,
-      "groupIds": [],
-      "strokeSharpness": "sharp",
-      "boundElementIds": []
-    },
-    {
-      "id": "zeDNXaEe6KkqqNB6hWn2v",
-      "type": "text",
-      "x": 778.9382934570312,
-      "y": 115.62533569335938,
-      "width": 91,
-      "height": 50,
-      "angle": 0,
-      "strokeColor": "#000000",
-      "backgroundColor": "transparent",
-      "fillStyle": "hachure",
-      "strokeWidth": 1,
-      "strokeStyle": "solid",
-      "roughness": 1,
-      "opacity": 100,
-      "groupIds": [],
-      "strokeSharpness": "sharp",
-      "seed": 2105824340,
-      "version": 137,
-      "versionNonce": 1352955220,
-      "isDeleted": false,
-      "boundElementIds": null,
-      "text": "OS\nPackages",
-      "fontSize": 20,
-      "fontFamily": 1,
-      "textAlign": "center",
-      "verticalAlign": "top",
-      "baseline": 43
-    },
-    {
-      "type": "text",
-      "version": 332,
-      "versionNonce": 1376205292,
-      "isDeleted": false,
-      "id": "8af38RMLhE245Uzw94tk3",
-      "fillStyle": "hachure",
-      "strokeWidth": 1,
-      "strokeStyle": "solid",
-      "roughness": 1,
-      "opacity": 100,
-      "angle": 0,
-      "x": 1205.6143035888672,
-      "y": 103.33536529541016,
-      "strokeColor": "#000000",
-      "backgroundColor": "transparent",
-      "width": 106,
-      "height": 80,
-      "seed": 1813092204,
+      "seed": 595309038,
       "groupIds": [],
       "strokeSharpness": "sharp",
       "boundElementIds": [],
-      "fontSize": 16,
+      "fontSize": 20,
       "fontFamily": 1,
-      "text": "Programming\nLanguage\nDependencies\n",
-      "baseline": 75,
+      "text": "Misconfiguration",
+      "baseline": 18,
       "textAlign": "center",
       "verticalAlign": "middle"
     },
     {
       "type": "rectangle",
-      "version": 523,
-      "versionNonce": 546482900,
+      "version": 1035,
+      "versionNonce": 1646453614,
       "isDeleted": false,
-      "id": "EW10DZBtAPDl2g3lG4Khk",
+      "id": "SPkrBrH6DGvkgQXtZQjIJ",
       "fillStyle": "hachure",
       "strokeWidth": 1,
       "strokeStyle": "solid",
       "roughness": 1,
       "opacity": 100,
       "angle": 0,
-      "x": 1050.4884185791016,
-      "y": 98.33513641357422,
+      "x": 959.9851989746094,
+      "y": 170.4835319519043,
       "strokeColor": "#000000",
-      "backgroundColor": "#4c6ef5",
-      "width": 128.3895263671875,
-      "height": 79.7976837158203,
-      "seed": 1225188692,
-      "groupIds": [],
-      "strokeSharpness": "sharp",
-      "boundElementIds": []
-    },
-    {
-      "id": "rAQf9FyIl2L5AB1n9JzFk",
-      "type": "text",
-      "x": 1069.5552215576172,
-      "y": 113.51881408691406,
-      "width": 91,
-      "height": 50,
-      "angle": 0,
-      "strokeColor": "#000000",
-      "backgroundColor": "transparent",
-      "fillStyle": "hachure",
-      "strokeWidth": 1,
-      "strokeStyle": "solid",
-      "roughness": 1,
-      "opacity": 100,
-      "groupIds": [],
-      "strokeSharpness": "sharp",
-      "seed": 1531169260,
-      "version": 213,
-      "versionNonce": 1734417516,
-      "isDeleted": false,
-      "boundElementIds": null,
-      "text": "OS\nPackages",
-      "fontSize": 20,
-      "fontFamily": 1,
-      "textAlign": "center",
-      "verticalAlign": "top",
-      "baseline": 43
-    },
-    {
-      "type": "rectangle",
-      "version": 705,
-      "versionNonce": 270413908,
-      "isDeleted": false,
-      "id": "nMqoqCtyNfMXk8kWry8kH",
-      "fillStyle": "hachure",
-      "strokeWidth": 1,
-      "strokeStyle": "solid",
-      "roughness": 1,
-      "opacity": 50,
-      "angle": 0,
-      "x": 1191.5499114990234,
-      "y": 97.8214340209961,
-      "strokeColor": "#000000",
-      "backgroundColor": "#15aabf",
-      "width": 130.7032470703125,
-      "height": 79.7976837158203,
-      "seed": 1126636244,
+      "backgroundColor": "#fa5252",
+      "width": 169.93957519531259,
+      "height": 77.80606079101562,
+      "seed": 1896460914,
       "groupIds": [],
       "strokeSharpness": "sharp",
       "boundElementIds": []
     },
     {
       "type": "text",
-      "version": 412,
-      "versionNonce": 1904079212,
+      "version": 532,
+      "versionNonce": 1887556210,
       "isDeleted": false,
-      "id": "J5C9c2LNI5fqAAEYp_jI2",
+      "id": "n06MNIqirDmVZBkDg_UPV",
       "fillStyle": "hachure",
       "strokeWidth": 1,
       "strokeStyle": "solid",
       "roughness": 1,
       "opacity": 100,
       "angle": 0,
-      "x": 1385.1761474609375,
-      "y": 103.10254669189453,
+      "x": 988.8137817382812,
+      "y": 196.69753646850586,
       "strokeColor": "#000000",
-      "backgroundColor": "transparent",
-      "width": 106,
-      "height": 80,
-      "seed": 546673900,
+      "backgroundColor": "#82c91e",
+      "width": 114,
+      "height": 25,
+      "seed": 1131832750,
       "groupIds": [],
       "strokeSharpness": "sharp",
       "boundElementIds": [],
-      "fontSize": 16,
+      "fontSize": 20,
       "fontFamily": 1,
-      "text": "Programming\nLanguage\nDependencies\n",
-      "baseline": 75,
+      "text": "Vulnerability",
+      "baseline": 18,
       "textAlign": "center",
       "verticalAlign": "middle"
     },
     {
       "type": "rectangle",
-      "version": 701,
-      "versionNonce": 1654991700,
+      "version": 1072,
+      "versionNonce": 789595566,
       "isDeleted": false,
-      "id": "PFi9vxp5euUTYOTLNztVZ",
+      "id": "0JP6OL7EFfoH4E4vFARFl",
       "fillStyle": "hachure",
       "strokeWidth": 1,
       "strokeStyle": "solid",
       "roughness": 1,
-      "opacity": 50,
+      "opacity": 100,
       "angle": 0,
-      "x": 1344.9087524414062,
-      "y": 96.26885223388672,
+      "x": 1508.9087371826172,
+      "y": 170.7038917541504,
       "strokeColor": "#000000",
-      "backgroundColor": "#15aabf",
-      "width": 198.17065429687491,
-      "height": 79.7976837158203,
-      "seed": 216760276,
+      "backgroundColor": "#82c91e",
+      "width": 169.93957519531259,
+      "height": 77.80606079101562,
+      "seed": 101784622,
       "groupIds": [],
       "strokeSharpness": "sharp",
       "boundElementIds": []
     },
     {
-      "id": "Uk7ac4Fk6B7eXS2IYB51e",
       "type": "text",
-      "x": 1613.747314453125,
-      "y": 305.670166015625,
-      "width": 81,
-      "height": 35,
-      "angle": 0,
-      "strokeColor": "#000000",
-      "backgroundColor": "transparent",
+      "version": 496,
+      "versionNonce": 1027781682,
+      "isDeleted": false,
+      "id": "jRmlh5MZuRKm3FtbC6qdZ",
       "fillStyle": "hachure",
       "strokeWidth": 1,
       "strokeStyle": "solid",
       "roughness": 1,
       "opacity": 100,
+      "angle": 0,
+      "x": 1517.237319946289,
+      "y": 196.91789627075195,
+      "strokeColor": "#000000",
+      "backgroundColor": "#82c91e",
+      "width": 155,
+      "height": 25,
+      "seed": 1950385586,
       "groupIds": [],
       "strokeSharpness": "sharp",
-      "seed": 1115855212,
-      "version": 77,
-      "versionNonce": 1712645100,
-      "isDeleted": false,
-      "boundElementIds": null,
-      "text": "Modes",
-      "fontSize": 28,
+      "boundElementIds": [],
+      "fontSize": 20,
       "fontFamily": 1,
+      "text": "Misconfiguration",
+      "baseline": 18,
       "textAlign": "center",
-      "verticalAlign": "top",
-      "baseline": 25
+      "verticalAlign": "middle"
     },
     {
-      "id": "AP0rLiNYZgZh6NpOg7FQl",
-      "type": "text",
-      "x": 1587.2977294921875,
-      "y": 214.689453125,
-      "width": 128,
-      "height": 35,
-      "angle": 0,
-      "strokeColor": "#000000",
-      "backgroundColor": "transparent",
+      "type": "rectangle",
+      "version": 1133,
+      "versionNonce": 882335726,
+      "isDeleted": false,
+      "id": "EQRF92xU4o9CfeHHvbd-a",
       "fillStyle": "hachure",
       "strokeWidth": 1,
       "strokeStyle": "solid",
       "roughness": 1,
       "opacity": 100,
+      "angle": 0,
+      "x": 1327.384536743164,
+      "y": 170.0898323059082,
+      "strokeColor": "#000000",
+      "backgroundColor": "#fa5252",
+      "width": 169.93957519531259,
+      "height": 77.80606079101562,
+      "seed": 1379493486,
       "groupIds": [],
       "strokeSharpness": "sharp",
-      "seed": 1133151724,
-      "version": 172,
-      "versionNonce": 1561108692,
-      "isDeleted": false,
-      "boundElementIds": null,
-      "text": "Artifacts",
-      "fontSize": 28,
-      "fontFamily": 1,
-      "textAlign": "center",
-      "verticalAlign": "top",
-      "baseline": 25
+      "boundElementIds": []
     },
     {
-      "id": "hyBBGwYCM6J4CIKDn9IYh",
       "type": "text",
-      "x": 1592.9608154296875,
-      "y": 118.49179077148438,
-      "width": 110,
-      "height": 35,
-      "angle": 0,
-      "strokeColor": "#000000",
-      "backgroundColor": "transparent",
+      "version": 569,
+      "versionNonce": 184638962,
+      "isDeleted": false,
+      "id": "_04YR8geM-ar9vZhNZtSj",
       "fillStyle": "hachure",
       "strokeWidth": 1,
       "strokeStyle": "solid",
       "roughness": 1,
       "opacity": 100,
+      "angle": 0,
+      "x": 1356.213119506836,
+      "y": 196.30383682250977,
+      "strokeColor": "#000000",
+      "backgroundColor": "#82c91e",
+      "width": 114,
+      "height": 25,
+      "seed": 357105522,
       "groupIds": [],
       "strokeSharpness": "sharp",
-      "seed": 733312980,
-      "version": 248,
-      "versionNonce": 1076463212,
+      "boundElementIds": [],
+      "fontSize": 20,
+      "fontFamily": 1,
+      "text": "Vulnerability",
+      "baseline": 18,
+      "textAlign": "center",
+      "verticalAlign": "middle"
+    },
+    {
+      "type": "rectangle",
+      "version": 1215,
+      "versionNonce": 650195502,
       "isDeleted": false,
-      "boundElementIds": null,
-      "text": "Targets",
+      "id": "8SHSNGf7PNddFLi2ZA3Vi",
+      "fillStyle": "hachure",
+      "strokeWidth": 1,
+      "strokeStyle": "solid",
+      "roughness": 1,
+      "opacity": 100,
+      "angle": 0,
+      "x": 599.9767150878906,
+      "y": 169.0025749206543,
+      "strokeColor": "#000000",
+      "backgroundColor": "#fa5252",
+      "width": 344.1738281250001,
+      "height": 77.80606079101562,
+      "seed": 1986948530,
+      "groupIds": [],
+      "strokeSharpness": "sharp",
+      "boundElementIds": []
+    },
+    {
+      "type": "text",
+      "version": 680,
+      "versionNonce": 113561522,
+      "isDeleted": false,
+      "id": "3Z5w3RXdgpvP43dlHqq26",
+      "fillStyle": "hachure",
+      "strokeWidth": 1,
+      "strokeStyle": "solid",
+      "roughness": 1,
+      "opacity": 100,
+      "angle": 0,
+      "x": 700.3721618652344,
+      "y": 190.79421615600586,
+      "strokeColor": "#000000",
+      "backgroundColor": "#82c91e",
+      "width": 160,
+      "height": 35,
+      "seed": 1077804654,
+      "groupIds": [],
+      "strokeSharpness": "sharp",
+      "boundElementIds": [],
       "fontSize": 28,
       "fontFamily": 1,
+      "text": "Vulnerability",
+      "baseline": 25,
       "textAlign": "center",
-      "verticalAlign": "top",
-      "baseline": 25
+      "verticalAlign": "middle"
     }
   ],
   "appState": {

docs/index.md

@@ -1,64 +1,49 @@
-# Welcome to {{ config.site_name }} 
+---
+hide:
+- navigation
+- toc
+---
 
-A Simple and Comprehensive Vulnerability Scanner for Containers and other Artifacts, Suitable for CI.
+![logo](imgs/logo.png){ align=left }
 
-# Abstract
-`Trivy` (`tri` pronounced like **tri**gger, `vy` pronounced like en**vy**) is a simple and comprehensive vulnerability scanner for containers and other artifacts.
+`Trivy` (`tri` pronounced like **tri**gger, `vy` pronounced like en**vy**) is a simple and comprehensive [vulnerability][vulnerability]/[misconfiguration][misconf] scanner for containers and other artifacts.
 A software vulnerability is a glitch, flaw, or weakness present in the software or in an Operating System.
-`Trivy` detects vulnerabilities of OS packages (Alpine, RHEL, CentOS, etc.) and application dependencies (Bundler, Composer, npm, yarn, etc.).
-`Trivy` is easy to use. Just install the binary and you're ready to scan. All you need to do for scanning is to specify a target such as an image name of the container.
+`Trivy` detects vulnerabilities of [OS packages][os] (Alpine, RHEL, CentOS, etc.) and [language-specific packages][lang] (Bundler, Composer, npm, yarn, etc.).
+In addition, `Trivy` scans [Infrastructure as Code (IaC) files][iac] such as Terraform and Kubernetes, to detect potential configuration issues that expose your deployments to the risk of attack.
+`Trivy` is easy to use. Just install the binary and you're ready to scan.
+All you need to do for scanning is to specify a target such as an image name of the container.
 
-<img src="imgs/overview.png" width="700">
+<div style="text-align: center">
+    <img src="imgs/overview.png" width="800">
+</div>
 
-Trivy can be run in two different modes:
 
-- [Standalone](./modes/standalone.md)
-- [Client/Server](./modes/client-server.md)
+<div style="text-align: center; margin-top: 150px">
+    <h1 id="demo">Demo</h1>
+</div>
 
-Trivy can scan three different artifacts:
+<figure style="text-aligh: center">
+  <img src="imgs/vuln-demo.gif" width="1000">
+  <figcaption>Demo: Vulnerability Detection</figcaption>
+</figure>
 
-- [Container Images](./scanning/image.md)
-- [Filesystem](./scanning/filesystem.md)
-- [Git Repositories](./scanning/git-repository.md)
+<figure style="text-aligh: center">
+  <img src="imgs/misconf-demo.gif" width="1000">
+  <figcaption>Demo: Misconfiguration Detection</figcaption>
+</figure>
 
-<img src="imgs/usage.gif" width="700">
-<img src="imgs/usage1.png" width="600">
-<img src="imgs/usage2.png" width="600">
+---
 
-It is considered to be used in CI. Before pushing to a container registry or deploying your application, you can scan your local container image and other artifacts easily.
-See [here](./integrations/index.md) for details.
+Trivy is an [Aqua Security][aquasec] open source project.  
+Learn about our open source work and portfolio [here][oss].  
+Contact us about any matter by opening a GitHub Discussion [here][discussions]
 
-## Features
+[vulnerability]: vulnerability/scanning/index.md
+[misconf]: misconfiguration/index.md
+[os]: vulnerability/detection/os.md
+[lang]: vulnerability/detection/language.md
+[iac]: misconfiguration/iac.md
 
-- Detect comprehensive vulnerabilities
-    - OS packages (Alpine, **Red Hat Universal Base Image**, Red Hat Enterprise Linux, CentOS, Oracle Linux, Debian, Ubuntu, Amazon Linux, openSUSE Leap, SUSE Enterprise Linux, Photon OS and Distroless)
-    - **Application dependencies** (Bundler, Composer, Pipenv, Poetry, npm, yarn, Cargo, NuGet, Maven, and Go)
-- Simple
-    - Specify only an image name or artifact name
-    - See [Quick Start](quickstart.md) and [Examples](examples/index.md)
-- Fast
-    - The first scan will finish within 10 seconds (depending on your network). Consequent scans will finish in single seconds.
-    - Unlike other scanners that take long to fetch vulnerability information (~10 minutes) on the first run, and encourage you to maintain a durable vulnerability database, Trivy is stateless and requires no maintenance or preparation.
-- Easy installation
-    - `apt-get install`, `yum install` and `brew install` is possible (See [Installation](installation.md))
-    - **No pre-requisites** such as installation of DB, libraries, etc.
-- High accuracy
-    - **Especially Alpine Linux and RHEL/CentOS**
-    - Other OSes are also high
-- DevSecOps
-    - **Suitable for CI** such as Travis CI, CircleCI, Jenkins, GitLab CI, etc.
-    - See [CI Example](integrations/index.md)
-- Support multiple formats
-    - container image
-        - A local image in Docker Engine which is running as a daemon
-        - A local image in Podman (>=2.0) which is exposing a socket
-        - A remote image in Docker Registry such as Docker Hub, ECR, GCR and ACR
-        - A tar archive stored in the `docker save` / `podman save` formatted file
-        - An image directory compliant with [OCI Image Format](https://github.com/opencontainers/image-spec)
-    - local filesystem
-    - remote git repository
-
-Please see [LICENSE](https://github.com/aquasecurity/trivy/blob/main/LICENSE) for Trivy licensing information.
-
-!!! note
-    Trivy uses vulnerability information from a variety of sources, some of which are licensed for non-commercial use only.
+[aquasec]: https://aquasec.com
+[oss]: https://www.aquasec.com/products/open-source-projects/
+[discussions]: https://github.com/aquasecurity/trivy/discussions

docs/misconfiguration/comparison/cfsec.md

@@ -0,0 +1,25 @@
+# vs cfsec
+[cfsec][cfsec] uses static analysis of your CloudFormation templates to spot potential security issues.
+Trivy uses cfsec internally to scan both JSON and YAML configuration files, but Trivy doesn't support some features provided by cfsec.
+This section describes the differences between Trivy and cfsec.
+
+| Feature                     | Trivy                                   | cfsec                |
+| --------------------------- | --------------------------------------- | -------------------- |
+| Built-in Policies           | :material-check:                        | :material-check:     |
+| Custom Policies             | Rego[^1]                                | :material-close:     |
+| Policy Metadata[^2]         | :material-check:                        | :material-check:     |
+| Show Successes              | :material-check:                        | :material-check:     |
+| Disable Policies            | :material-check:                        | :material-check:     |
+| Show Issue Lines            | :material-close:                        | :material-check:     |
+| View Statistics             | :material-close:                        | :material-check:     |
+| Filtering by Severity       | :material-check:                        | :material-close:     |
+| Supported Formats           | Dockerfile, JSON, YAML, Terraform, etc. | CloudFormation JSON and YAML       |
+
+[^1]: CloudFormation files are not supported
+[^2]: To enrich the results such as ID, Title, Description, Severity, etc.
+
+cfsec is designed for CloudFormation.
+People who use only want to scan their CloudFormation templates should use cfsec.
+People who want to scan a wide range of configuration files should use Trivy.
+
+[cfsec]: https://github.com/aquasecurity/cfsec

docs/misconfiguration/comparison/conftest.md

@@ -0,0 +1,43 @@
+# vs Conftest
+[Conftest][conftest] is a really nice tool to help you write tests against structured configuration data.
+Misconfiguration detection in Trivy is heavily inspired by Conftest and provides similar features Conftest has.
+This section describes the differences between Trivy and Conftest.
+
+| Feature                     | Trivy                | Conftest             |
+| --------------------------- | -------------------- | -------------------- |
+| Support Rego Language       | :material-check:     | :material-check:     |
+| Built-in Policies           | :material-check:     | :material-close:     |
+| Custom Policies             | :material-check:     | :material-check:     |
+| Custom Data                 | :material-check:     | :material-check:     |
+| Combine                     | :material-check:     | :material-check:     |
+| Combine per Policy          | :material-check:     | :material-close:     |
+| Policy Input Selector[^1]   | :material-check:     | :material-close:     |
+| Policy Metadata[^2]         | :material-check:     | :material-close:[^3] |
+| Filtering by Severity       | :material-check:     | :material-close:     |
+| Rule-based Exceptions       | :material-check:     | :material-check:     |
+| Namespace-based Exceptions  | :material-check:     | :material-close:     |
+| Sharing Policies            | :material-close:     | :material-check:     |
+| Show Successes              | :material-check:     | :material-close:     |
+| Flexible Exit Code          | :material-check:     | :material-close:     |
+| Rego Unit Tests             | :material-close:[^4] | :material-check:     |
+| Go Testing                  | :material-check:     | :material-close:     |
+| Verbose Trace               | :material-check:     | :material-check:     |
+| Supported Formats           | 6 formats[^5]        | 14 formats[^6]       |
+
+Trivy offers built-in policies and a variety of options, while Conftest only supports custom policies.
+In other words, Conftest is simpler and lighter.
+
+Conftest is a general testing tool for configuration files, and Trivy is more security-focused.
+People who need an out-of-the-box misconfiguration scanner should use Trivy.
+People who don't need built-in policies and write your policies should use Conftest.
+
+[^1]: Pass only the types of configuration file as input, specified in selector
+[^2]: To enrich the results such as ID, Title, Description, etc.
+[^3]: Conftest supports [structured errors in rules][conftest-structured], but they are free format and not natively supported by Conftest.
+[^4]: Trivy is not able to run `*_test.rego` like `conftest verify`.
+[^5]: Dockerfile, HCL, HCL2, JSON, TOML, and YAML
+[^6]: CUE, Dockerfile, EDN, HCL, HCL2, HOCON, Ignore files, INI, JSON, Jsonnet, TOML, VCL, XML, and YAML
+
+
+[conftest-structured]: https://github.com/open-policy-agent/conftest/pull/243
+[conftest]: https://github.com/open-policy-agent/conftest

docs/misconfiguration/comparison/tfsec.md

@@ -0,0 +1,26 @@
+# vs tfsec
+[tfsec][tfsec] uses static analysis of your Terraform templates to spot potential security issues.
+Trivy uses tfsec internally to scan Terraform HCL files, but Trivy doesn't support some features provided by tfsec.
+This section describes the differences between Trivy and tfsec.
+
+| Feature                     | Trivy                                   | tfsec                |
+| --------------------------- | --------------------------------------- | -------------------- |
+| Built-in Policies           | :material-check:                        | :material-check:     |
+| Custom Policies             | Rego[^1]                                | JSON and YAML        |
+| Policy Metadata[^2]         | :material-check:                        | :material-check:     |
+| Show Successes              | :material-check:                        | :material-check:     |
+| Disable Policies            | :material-check:                        | :material-check:     |
+| Show Issue Lines            | :material-close:                        | :material-check:     |
+| Support .tfvars             | :material-close:                        | :material-check:     |
+| View Statistics             | :material-close:                        | :material-check:     |
+| Filtering by Severity       | :material-check:                        | :material-close:     |
+| Supported Formats           | Dockerfile, JSON, YAML, Terraform, etc. | Terraform            |
+
+[^1]: Terraform HCL files are not supported.
+[^2]: To enrich the results such as ID, Title, Description, Severity, etc.
+
+tfsec is designed for Terraform.
+People who use only Terraform should use tfsec.
+People who want to scan a wide range of configuration files should use Trivy.
+
+[tfsec]: https://github.com/aquasecurity/tfsec

docs/misconfiguration/custom/combine.md

@@ -0,0 +1,44 @@
+# Combined input
+
+## Overview
+Trivy usually scans each configuration file individually. 
+Sometimes it might be useful to compare values from different configuration files simultaneously.
+
+When `combine` is set to true, all config files under the specified directory are combined into one input data structure.
+
+!!! example
+    ```
+    __rego_input__ := {
+        "combine": false,
+    }
+    ```
+
+In "combine" mode, the `input` document becomes an array, where each element is an object with two fields:
+
+- `"path": "path/to/file"`: the relative file path of the respective file
+- `"contents": ...`: the parsed content of the respective file
+
+Now you can ensure that duplicate values match across the entirety of your configuration files.
+
+## Return value
+In "combine" mode, the `deny` entrypoint must return an object with two keys
+
+`filepath` (required)
+: the relative file path of the file being evaluated
+
+`msg` (required)
+: the message describing an issue
+
+!!! example
+    ```
+    deny[res] {
+        resource := input[i].contents
+        ... some logic ...
+
+    	res := {
+    		"filepath": input[i].path,
+    		"msg": "something bad",
+    	}
+    }
+    ```
+

docs/misconfiguration/custom/data.md

@@ -0,0 +1,35 @@
+# Custom Data
+
+Custom policies may require additional data in order to determine an answer.
+
+For example, an allowed list of resources that can be created. 
+Instead of hardcoding this information inside of your policy, Trivy allows passing paths to data files with the `--data` flag.
+
+Given the following yaml file:
+
+```bash
+$ cd examples/misconf/custom-data
+$ cat data/ports.yaml                                                                                                                                                                      [~/src/github.com/aquasecurity/trivy/examples/misconf/custom-data]
+services:
+  ports:
+    - "20"
+    - "20/tcp"
+    - "20/udp"
+    - "23"
+    - "23/tcp"
+```
+
+This can be imported into your policy:
+
+```rego
+import data.services
+
+ports := services.ports
+```
+
+Then, you need to pass data paths through `--data` option.
+Trivy recursively searches the specified paths for JSON (`*.json`) and YAML (`*.yaml`) files.
+
+```bash
+$ trivy conf --policy ./policy --data data --namespaces user ./configs
+```

docs/misconfiguration/custom/debug.md

@@ -0,0 +1,225 @@
+# Debugging policies
+When working on more complex queries (or when learning Rego), it's useful to see exactly how the policy is applied.
+For this purpose you can use the `--trace` flag.
+This will output a large trace from Open Policy Agent like the following:
+
+!!! tip
+    Only failed policies show traces. If you want to debug a passed policy, you need to make it fail on purpose.
+
+```bash
+$ trivy conf --trace configs/
+2021-07-11T16:45:58.493+0300    INFO    Detected config files: 1
+
+Dockerfile (dockerfile)
+=======================
+Tests: 23 (SUCCESSES: 22, FAILURES: 1, EXCEPTIONS: 0)
+Failures: 1 (UNKNOWN: 0, LOW: 0, MEDIUM: 0, HIGH: 1, CRITICAL: 0)
+
++---------------------------+------------+----------------------+----------+------------------------------------------+
+|           TYPE            | MISCONF ID |        CHECK         | SEVERITY |                 MESSAGE                  |
++---------------------------+------------+----------------------+----------+------------------------------------------+
+| Dockerfile Security Check |   DS002    | Image user is 'root' |   HIGH   | Last USER command in                     |
+|                           |            |                      |          | Dockerfile should not be 'root'          |
+|                           |            |                      |          | -->avd.aquasec.com/appshield/ds002       |
++---------------------------+------------+----------------------+----------+------------------------------------------+
+
+ID: DS002
+File: Dockerfile
+Namespace: appshield.dockerfile.DS002
+Query: data.appshield.dockerfile.DS002.deny
+Message: Last USER command in Dockerfile should not be 'root'
+TRACE  Enter data.appshield.dockerfile.DS002.deny = _
+TRACE  | Eval data.appshield.dockerfile.DS002.deny = _
+TRACE  | Index data.appshield.dockerfile.DS002.deny matched 2 rules)
+TRACE  | Enter data.appshield.dockerfile.DS002.deny
+TRACE  | | Eval data.appshield.dockerfile.DS002.fail_user_count
+TRACE  | | Index data.appshield.dockerfile.DS002.fail_user_count (matched 1 rule)
+TRACE  | | Enter data.appshield.dockerfile.DS002.fail_user_count
+TRACE  | | | Eval __local559__ = data.appshield.dockerfile.DS002.get_user
+TRACE  | | | Index data.appshield.dockerfile.DS002.get_user (matched 1 rule)
+TRACE  | | | Enter data.appshield.dockerfile.DS002.get_user
+TRACE  | | | | Eval user = data.lib.docker.user[_]
+TRACE  | | | | Index data.lib.docker.user (matched 1 rule)
+TRACE  | | | | Enter data.lib.docker.user
+TRACE  | | | | | Eval instruction = input.stages[_][_]
+TRACE  | | | | | Eval instruction.Cmd = "user"
+TRACE  | | | | | Fail instruction.Cmd = "user"
+TRACE  | | | | | Redo instruction = input.stages[_][_]
+TRACE  | | | | | Eval instruction.Cmd = "user"
+TRACE  | | | | | Fail instruction.Cmd = "user"
+TRACE  | | | | | Redo instruction = input.stages[_][_]
+TRACE  | | | | | Eval instruction.Cmd = "user"
+TRACE  | | | | | Fail instruction.Cmd = "user"
+TRACE  | | | | | Redo instruction = input.stages[_][_]
+TRACE  | | | | | Eval instruction.Cmd = "user"
+TRACE  | | | | | Fail instruction.Cmd = "user"
+TRACE  | | | | | Redo instruction = input.stages[_][_]
+TRACE  | | | | | Eval instruction.Cmd = "user"
+TRACE  | | | | | Fail instruction.Cmd = "user"
+TRACE  | | | | | Redo instruction = input.stages[_][_]
+TRACE  | | | | | Eval instruction.Cmd = "user"
+TRACE  | | | | | Fail instruction.Cmd = "user"
+TRACE  | | | | | Redo instruction = input.stages[_][_]
+TRACE  | | | | | Eval instruction.Cmd = "user"
+TRACE  | | | | | Fail instruction.Cmd = "user"
+TRACE  | | | | | Redo instruction = input.stages[_][_]
+TRACE  | | | | | Eval instruction.Cmd = "user"
+TRACE  | | | | | Exit data.lib.docker.user
+TRACE  | | | | Eval username = user.Value[_]
+TRACE  | | | | Exit data.appshield.dockerfile.DS002.get_user
+TRACE  | | | Redo data.appshield.dockerfile.DS002.get_user
+TRACE  | | | | Redo username = user.Value[_]
+TRACE  | | | | Redo user = data.lib.docker.user[_]
+TRACE  | | | | Redo data.lib.docker.user
+TRACE  | | | | | Redo instruction.Cmd = "user"
+TRACE  | | | | | Redo instruction = input.stages[_][_]
+TRACE  | | | | | Eval instruction.Cmd = "user"
+TRACE  | | | | | Exit data.lib.docker.user
+TRACE  | | | | Eval username = user.Value[_]
+TRACE  | | | | Exit data.appshield.dockerfile.DS002.get_user
+TRACE  | | | Redo data.appshield.dockerfile.DS002.get_user
+TRACE  | | | | Redo username = user.Value[_]
+TRACE  | | | | Redo user = data.lib.docker.user[_]
+TRACE  | | | | Redo data.lib.docker.user
+TRACE  | | | | | Redo instruction.Cmd = "user"
+TRACE  | | | | | Redo instruction = input.stages[_][_]
+TRACE  | | | | | Eval instruction.Cmd = "user"
+TRACE  | | | | | Fail instruction.Cmd = "user"
+TRACE  | | | | | Redo instruction = input.stages[_][_]
+TRACE  | | | Eval count(__local559__, __local391__)
+TRACE  | | | Eval lt(__local391__, 1)
+TRACE  | | | Fail lt(__local391__, 1)
+TRACE  | | | Redo count(__local559__, __local391__)
+TRACE  | | | Redo __local559__ = data.appshield.dockerfile.DS002.get_user
+TRACE  | | Fail data.appshield.dockerfile.DS002.fail_user_count
+TRACE  | Enter data.appshield.dockerfile.DS002.deny
+TRACE  | | Eval data.appshield.dockerfile.DS002.fail_last_user_root
+TRACE  | | Index data.appshield.dockerfile.DS002.fail_last_user_root (matched 1 rule)
+TRACE  | | Enter data.appshield.dockerfile.DS002.fail_last_user_root
+TRACE  | | | Eval __local560__ = data.appshield.dockerfile.DS002.get_user
+TRACE  | | | Index data.appshield.dockerfile.DS002.get_user (matched 1 rule)
+TRACE  | | | Enter data.appshield.dockerfile.DS002.get_user
+TRACE  | | | | Eval user = data.lib.docker.user[_]
+TRACE  | | | | Index data.lib.docker.user (matched 1 rule)
+TRACE  | | | | Enter data.lib.docker.user
+TRACE  | | | | | Eval instruction = input.stages[_][_]
+TRACE  | | | | | Eval instruction.Cmd = "user"
+TRACE  | | | | | Fail instruction.Cmd = "user"
+TRACE  | | | | | Redo instruction = input.stages[_][_]
+TRACE  | | | | | Eval instruction.Cmd = "user"
+TRACE  | | | | | Fail instruction.Cmd = "user"
+TRACE  | | | | | Redo instruction = input.stages[_][_]
+TRACE  | | | | | Eval instruction.Cmd = "user"
+TRACE  | | | | | Fail instruction.Cmd = "user"
+TRACE  | | | | | Redo instruction = input.stages[_][_]
+TRACE  | | | | | Eval instruction.Cmd = "user"
+TRACE  | | | | | Fail instruction.Cmd = "user"
+TRACE  | | | | | Redo instruction = input.stages[_][_]
+TRACE  | | | | | Eval instruction.Cmd = "user"
+TRACE  | | | | | Fail instruction.Cmd = "user"
+TRACE  | | | | | Redo instruction = input.stages[_][_]
+TRACE  | | | | | Eval instruction.Cmd = "user"
+TRACE  | | | | | Fail instruction.Cmd = "user"
+TRACE  | | | | | Redo instruction = input.stages[_][_]
+TRACE  | | | | | Eval instruction.Cmd = "user"
+TRACE  | | | | | Fail instruction.Cmd = "user"
+TRACE  | | | | | Redo instruction = input.stages[_][_]
+TRACE  | | | | | Eval instruction.Cmd = "user"
+TRACE  | | | | | Exit data.lib.docker.user
+TRACE  | | | | Eval username = user.Value[_]
+TRACE  | | | | Exit data.appshield.dockerfile.DS002.get_user
+TRACE  | | | Redo data.appshield.dockerfile.DS002.get_user
+TRACE  | | | | Redo username = user.Value[_]
+TRACE  | | | | Redo user = data.lib.docker.user[_]
+TRACE  | | | | Redo data.lib.docker.user
+TRACE  | | | | | Redo instruction.Cmd = "user"
+TRACE  | | | | | Redo instruction = input.stages[_][_]
+TRACE  | | | | | Eval instruction.Cmd = "user"
+TRACE  | | | | | Exit data.lib.docker.user
+TRACE  | | | | Eval username = user.Value[_]
+TRACE  | | | | Exit data.appshield.dockerfile.DS002.get_user
+TRACE  | | | Redo data.appshield.dockerfile.DS002.get_user
+TRACE  | | | | Redo username = user.Value[_]
+TRACE  | | | | Redo user = data.lib.docker.user[_]
+TRACE  | | | | Redo data.lib.docker.user
+TRACE  | | | | | Redo instruction.Cmd = "user"
+TRACE  | | | | | Redo instruction = input.stages[_][_]
+TRACE  | | | | | Eval instruction.Cmd = "user"
+TRACE  | | | | | Fail instruction.Cmd = "user"
+TRACE  | | | | | Redo instruction = input.stages[_][_]
+TRACE  | | | Eval cast_array(__local560__, __local392__)
+TRACE  | | | Eval user = __local392__
+TRACE  | | | Eval __local561__ = data.appshield.dockerfile.DS002.get_user
+TRACE  | | | Index data.appshield.dockerfile.DS002.get_user (matched 1 rule)
+TRACE  | | | Enter data.appshield.dockerfile.DS002.get_user
+TRACE  | | | | Eval user = data.lib.docker.user[_]
+TRACE  | | | | Index data.lib.docker.user (matched 1 rule)
+TRACE  | | | | Enter data.lib.docker.user
+TRACE  | | | | | Eval instruction = input.stages[_][_]
+TRACE  | | | | | Eval instruction.Cmd = "user"
+TRACE  | | | | | Fail instruction.Cmd = "user"
+TRACE  | | | | | Redo instruction = input.stages[_][_]
+TRACE  | | | | | Eval instruction.Cmd = "user"
+TRACE  | | | | | Fail instruction.Cmd = "user"
+TRACE  | | | | | Redo instruction = input.stages[_][_]
+TRACE  | | | | | Eval instruction.Cmd = "user"
+TRACE  | | | | | Fail instruction.Cmd = "user"
+TRACE  | | | | | Redo instruction = input.stages[_][_]
+TRACE  | | | | | Eval instruction.Cmd = "user"
+TRACE  | | | | | Fail instruction.Cmd = "user"
+TRACE  | | | | | Redo instruction = input.stages[_][_]
+TRACE  | | | | | Eval instruction.Cmd = "user"
+TRACE  | | | | | Fail instruction.Cmd = "user"
+TRACE  | | | | | Redo instruction = input.stages[_][_]
+TRACE  | | | | | Eval instruction.Cmd = "user"
+TRACE  | | | | | Fail instruction.Cmd = "user"
+TRACE  | | | | | Redo instruction = input.stages[_][_]
+TRACE  | | | | | Eval instruction.Cmd = "user"
+TRACE  | | | | | Fail instruction.Cmd = "user"
+TRACE  | | | | | Redo instruction = input.stages[_][_]
+TRACE  | | | | | Eval instruction.Cmd = "user"
+TRACE  | | | | | Exit data.lib.docker.user
+TRACE  | | | | Eval username = user.Value[_]
+TRACE  | | | | Exit data.appshield.dockerfile.DS002.get_user
+TRACE  | | | Redo data.appshield.dockerfile.DS002.get_user
+TRACE  | | | | Redo username = user.Value[_]
+TRACE  | | | | Redo user = data.lib.docker.user[_]
+TRACE  | | | | Redo data.lib.docker.user
+TRACE  | | | | | Redo instruction.Cmd = "user"
+TRACE  | | | | | Redo instruction = input.stages[_][_]
+TRACE  | | | | | Eval instruction.Cmd = "user"
+TRACE  | | | | | Exit data.lib.docker.user
+TRACE  | | | | Eval username = user.Value[_]
+TRACE  | | | | Exit data.appshield.dockerfile.DS002.get_user
+TRACE  | | | Redo data.appshield.dockerfile.DS002.get_user
+TRACE  | | | | Redo username = user.Value[_]
+TRACE  | | | | Redo user = data.lib.docker.user[_]
+TRACE  | | | | Redo data.lib.docker.user
+TRACE  | | | | | Redo instruction.Cmd = "user"
+TRACE  | | | | | Redo instruction = input.stages[_][_]
+TRACE  | | | | | Eval instruction.Cmd = "user"
+TRACE  | | | | | Fail instruction.Cmd = "user"
+TRACE  | | | | | Redo instruction = input.stages[_][_]
+TRACE  | | | Eval count(__local561__, __local393__)
+TRACE  | | | Eval len = __local393__
+TRACE  | | | Eval minus(len, 1, __local394__)
+TRACE  | | | Eval user[__local394__] = "root"
+TRACE  | | | Exit data.appshield.dockerfile.DS002.fail_last_user_root
+TRACE  | | Eval res = "Last USER command in Dockerfile should not be 'root'"
+TRACE  | | Exit data.appshield.dockerfile.DS002.deny
+TRACE  | Redo data.appshield.dockerfile.DS002.deny
+TRACE  | | Redo res = "Last USER command in Dockerfile should not be 'root'"
+TRACE  | | Redo data.appshield.dockerfile.DS002.fail_last_user_root
+TRACE  | | Redo data.appshield.dockerfile.DS002.fail_last_user_root
+TRACE  | | | Redo user[__local394__] = "root"
+TRACE  | | | Redo minus(len, 1, __local394__)
+TRACE  | | | Redo len = __local393__
+TRACE  | | | Redo count(__local561__, __local393__)
+TRACE  | | | Redo __local561__ = data.appshield.dockerfile.DS002.get_user
+TRACE  | | | Redo user = __local392__
+TRACE  | | | Redo cast_array(__local560__, __local392__)
+TRACE  | | | Redo __local560__ = data.appshield.dockerfile.DS002.get_user
+TRACE  | Exit data.appshield.dockerfile.DS002.deny = _
+TRACE  Redo data.appshield.dockerfile.DS002.deny = _
+TRACE  | Redo data.appshield.dockerfile.DS002.deny = _
+```

docs/misconfiguration/custom/examples.md

@@ -0,0 +1,296 @@
+# Examples
+
+## Custom Policy
+### Kubernetes
+See [here][k8s].
+
+The custom policy is defined in `user.kubernetes.ID001` package.
+You need to pass the package prefix you want to evaluate through `--namespaces` option.
+In this case, the package prefix should be `user`, `user.kuberntes`, or `user.kubernetes.ID001`.
+
+### Dockerfile
+See [here][dockerfile].
+
+The input will be a dictionary of stages.
+
+#### Single Stage
+
+??? example
+    Dockerfile
+    ```dockerfile
+    FROM foo
+    COPY . /
+    RUN echo hello
+    ```
+
+    Rego Input
+    ```json
+    {
+        "stages": {
+            "foo": [
+                {
+                    "Cmd": "from",
+                    "EndLine": 1,
+                    "Flags": [],
+                    "JSON": false,
+                    "Original": "FROM foo",
+                    "Stage": 0,
+                    "StartLine": 1,
+                    "SubCmd": "",
+                    "Value": [
+                        "foo"
+                    ]
+                },
+                {
+                    "Cmd": "copy",
+                    "EndLine": 2,
+                    "Flags": [],
+                    "JSON": false,
+                    "Original": "COPY . /",
+                    "Stage": 0,
+                    "StartLine": 2,
+                    "SubCmd": "",
+                    "Value": [
+                        ".",
+                        "/"
+                    ]
+                },
+                {
+                    "Cmd": "run",
+                    "EndLine": 3,
+                    "Flags": [],
+                    "JSON": false,
+                    "Original": "RUN echo hello",
+                    "Stage": 0,
+                    "StartLine": 3,
+                    "SubCmd": "",
+                    "Value": [
+                        "echo hello"
+                    ]
+                }
+            ]
+        }
+    }
+    ```
+
+#### Multi Stage
+
+??? example
+    Dockerfile
+    ```dockerfile
+    FROM golang:1.16 AS builder
+    WORKDIR /go/src/github.com/alexellis/href-counter/
+    RUN go get -d -v golang.org/x/net/html
+    COPY app.go .
+    RUN CGO_ENABLED=0 GOOS=linux go build -a -installsuffix cgo -o app .
+    
+    FROM alpine:latest
+    RUN apk --no-cache add ca-certificates \
+    && apk add --no-cache bash
+    WORKDIR /root/
+    COPY --from=builder /go/src/github.com/alexellis/href-counter/app .
+    CMD ["./app"]
+    ```
+
+    Rego Input
+    ```json
+    {
+        "stages": {
+            "alpine:latest": [
+                {
+                    "Cmd": "from",
+                    "EndLine": 7,
+                    "Flags": [],
+                    "JSON": false,
+                    "Original": "FROM alpine:latest",
+                    "Stage": 1,
+                    "StartLine": 7,
+                    "SubCmd": "",
+                    "Value": [
+                        "alpine:latest"
+                    ]
+                },
+                {
+                    "Cmd": "run",
+                    "EndLine": 9,
+                    "Flags": [],
+                    "JSON": false,
+                    "Original": "RUN apk --no-cache add ca-certificates     \u0026\u0026 apk add --no-cache bash",
+                    "Stage": 1,
+                    "StartLine": 8,
+                    "SubCmd": "",
+                    "Value": [
+                        "apk --no-cache add ca-certificates     \u0026\u0026 apk add --no-cache bash"
+                    ]
+                },
+                {
+                    "Cmd": "workdir",
+                    "EndLine": 10,
+                    "Flags": [],
+                    "JSON": false,
+                    "Original": "WORKDIR /root/",
+                    "Stage": 1,
+                    "StartLine": 10,
+                    "SubCmd": "",
+                    "Value": [
+                        "/root/"
+                    ]
+                },
+                {
+                    "Cmd": "copy",
+                    "EndLine": 11,
+                    "Flags": [
+                        "--from=builder"
+                    ],
+                    "JSON": false,
+                    "Original": "COPY --from=builder /go/src/github.com/alexellis/href-counter/app .",
+                    "Stage": 1,
+                    "StartLine": 11,
+                    "SubCmd": "",
+                    "Value": [
+                        "/go/src/github.com/alexellis/href-counter/app",
+                        "."
+                    ]
+                },
+                {
+                    "Cmd": "cmd",
+                    "EndLine": 12,
+                    "Flags": [],
+                    "JSON": true,
+                    "Original": "CMD [\"./app\"]",
+                    "Stage": 1,
+                    "StartLine": 12,
+                    "SubCmd": "",
+                    "Value": [
+                        "./app"
+                    ]
+                }
+            ],
+            "golang:1.16 AS builder": [
+                {
+                    "Cmd": "from",
+                    "EndLine": 1,
+                    "Flags": [],
+                    "JSON": false,
+                    "Original": "FROM golang:1.16 AS builder",
+                    "Stage": 0,
+                    "StartLine": 1,
+                    "SubCmd": "",
+                    "Value": [
+                        "golang:1.16",
+                        "AS",
+                        "builder"
+                    ]
+                },
+                {
+                    "Cmd": "workdir",
+                    "EndLine": 2,
+                    "Flags": [],
+                    "JSON": false,
+                    "Original": "WORKDIR /go/src/github.com/alexellis/href-counter/",
+                    "Stage": 0,
+                    "StartLine": 2,
+                    "SubCmd": "",
+                    "Value": [
+                        "/go/src/github.com/alexellis/href-counter/"
+                    ]
+                    },
+                {
+                    "Cmd": "run",
+                    "EndLine": 3,
+                    "Flags": [],
+                    "JSON": false,
+                    "Original": "RUN go get -d -v golang.org/x/net/html",
+                    "Stage": 0,
+                    "StartLine": 3,
+                    "SubCmd": "",
+                    "Value": [
+                        "go get -d -v golang.org/x/net/html"
+                    ]
+                },
+                {
+                    "Cmd": "copy",
+                    "EndLine": 4,
+                    "Flags": [],
+                    "JSON": false,
+                    "Original": "COPY app.go .",
+                    "Stage": 0,
+                    "StartLine": 4,
+                    "SubCmd": "",
+                    "Value": [
+                        "app.go",
+                        "."
+                    ]
+                },
+                {
+                    "Cmd": "run",
+                    "EndLine": 5,
+                    "Flags": [],
+                    "JSON": false,
+                    "Original": "RUN CGO_ENABLED=0 GOOS=linux go build -a -installsuffix cgo -o app .",
+                    "Stage": 0,
+                    "StartLine": 5,
+                    "SubCmd": "",
+                    "Value": [
+                        "CGO_ENABLED=0 GOOS=linux go build -a -installsuffix cgo -o app ."
+                    ]
+                }
+            ]
+        }
+    }
+    ```
+
+### Docker Compose
+See [here][compose].
+
+Docker Compose uses YAML format for configurations. You can apply your Rego policies to `docker-compose.yml`.
+
+### HCL
+See [here][hcl].
+
+Trivy parses HCL files and converts into structured data.
+
+!!! warning
+    Terraform HCL files are not supported yet.
+
+### Terraform Plan
+See [here][tfplan].
+
+Use the command [terraform show][terraform-show] to convert the Terraform plan into JSON so that OPA can read the plan.
+
+```bash
+$ terraform init
+$ terraform plan --out tfplan.binary
+$ terraform show -json tfplan.binary > tfplan.json
+```
+
+For more details, see also [OPA document][opa-terraform].
+
+### Serverless Framework
+See [here][serverless].
+
+Server Framework uses YAML format for configurations. You can apply your Rego policies to `serverless.yaml`.
+
+## Custom Data
+See [here][data].
+
+## Combined Input
+See [here][combine].
+
+## Go Testing
+See [here][go-testing].
+
+[k8s]:https://github.com/aquasecurity/trivy/tree/{{ git.commit }}/examples/misconf/custom-policy/kubernetes/
+[dockerfile]:https://github.com/aquasecurity/trivy/tree/{{ git.commit }}/examples/misconf/custom-policy/dockerfile/
+[compose]:https://github.com/aquasecurity/trivy/tree/{{ git.commit }}/examples/misconf/custom-policy/docker-compose/
+[hcl]:https://github.com/aquasecurity/trivy/tree/{{ git.commit }}/examples/misconf/custom-policy/hcl/
+[serverless]:https://github.com/aquasecurity/trivy/tree/{{ git.commit }}/examples/misconf/custom-policy/serverless/
+[tfplan]:https://github.com/aquasecurity/trivy/tree/{{ git.commit }}/examples/misconf/custom-policy/terraform-plan/
+[terraform-show]: https://www.terraform.io/docs/cli/commands/show.html
+[opa-terraform]: https://www.openpolicyagent.org/docs/latest/terraform/
+
+[custom]: https://github.com/aquasecurity/trivy/tree/{{ git.commit }}/examples/misconf/custom-policy
+[data]: https://github.com/aquasecurity/trivy/tree/{{ git.commit }}/examples/misconf/custom-data
+[combine]: https://github.com/aquasecurity/trivy/tree/{{ git.commit }}/examples/misconf/combine
+[go-testing]: https://github.com/aquasecurity/trivy/tree/{{ git.commit }}/examples/misconf/go-testing
+

docs/misconfiguration/custom/index.md

@@ -0,0 +1,183 @@
+# Custom Policies
+
+## Overview
+You can write custom policies in [Rego][rego].
+Once you finish writing custom policies, you can pass the directory where those policies are stored with `--policy` option.
+
+``` bash
+trivy conf --policy /path/to/custom_policies --namespaces user /path/to/config_dir
+```
+
+As for `--namespaces` option, the detail is described as below.
+
+### File formats
+If a file name matches the following file patterns, Trivy will parse the file and pass it as input to your Rego policy.
+
+| File format    | File pattern                                     |
+| -------------- | ------------------------------------------------ |
+| JSON           | `*.json`                                         |
+| YAML           | `*.yaml`                                         |
+| TOML           | `*.toml`                                         |
+| HCL            | `*.hcl`, `*.hcl1`, and `*.hcl2`                  |
+| Dockerfile     | `Dockerfile`, `Dockerfile.*`, and `*.Dockerfile` |
+
+### Configuration languages
+In the above general file formats, Trivy automatically identifies the following types of configuration files:
+
+- Ansible (YAML)
+- CloudFormation (JSON/YAML)
+- Kubernetes (JSON/YAML)
+
+This is useful for filtering inputs, as described below.
+
+!!! warning
+    Custom policies do not support Terraform at the moment.
+
+## Rego format
+A single package must contain only one policy.
+
+!!!example
+    ``` rego
+    package user.kubernetes.ID001
+    
+    __rego_metadata__ := {
+    	"id": "ID001",
+    	"title": "Deployment not allowed",
+    	"severity": "LOW",
+    	"type": "Custom Kubernetes Check",
+    	"description": "Deployments are not allowed because of some reasons.",
+    }
+
+    __rego_input__ := {
+        "selector": [
+            {"type": "kubernetes"},
+        ],
+    }
+    
+    deny[msg] {
+    	input.kind == "Deployment"
+    	msg = sprintf("Found deployment '%s' but deployments are not allowed", [input.metadata.name])
+    }
+    ```
+
+In this example, ID001 "Deployment not allowed" is defined under `user.kubernetes.ID001`.
+If you add a new custom policy, it must be defined under a new package like `user.kubernetes.ID002`.
+
+### Policy structure
+
+`package` (required)
+:   - MUST follow the Rego's [specification][package]
+    - MUST be unique per policy
+    - SHOULD include policy id for uniqueness
+    - MAY include the group name such as `kubernetes` for clarity
+        - Group name has no effect on policy evaluation
+
+`__rego_metadata__` (optional)
+:   - SHOULD be defined for clarity since these values will be displayed in the scan results
+
+`__rego_input__` (optional)
+:   - MAY be defined when you want to specify input format
+
+`deny` (required)
+:   - SHOULD be `deny` or start with `deny_`
+        - Although `warn`, `warn_*`, `violation`, `violation_` also work for compatibility, `deny` is recommended as severity can be defined in `__rego_metadata__`.
+    - SHOULD return `string`
+        - Although `object` with `msg` field is accepted, other fields are dropped and `string` is recommended.
+        - e.g. `{"msg": "deny message", "details": "something"}`
+    
+
+### Package
+A package name must be unique per policy.
+
+!!!example
+    ``` rego
+    package user.kubernetes.ID001
+    ```
+
+By default, only `appshield.*` packages will be evaluated.
+If you define custom packages, you have to specify the package prefix via `--namespaces` option. 
+
+``` bash
+trivy conf --policy /path/to/custom_policies --namespaces user /path/to/config_dir
+```
+
+In this case, `user.*` will be evaluated.
+Any package prefixes such as `main` and `user` are allowed.
+
+### Metadata
+Metadata helps enrich Trivy's scan results with useful information.
+
+!!!example
+    ``` rego
+    __rego_metadata__ := {
+    	"id": "ID001",
+    	"title": "Deployment not allowed",
+    	"severity": "LOW",
+    	"type": "Custom Kubernetes Check",
+    	"description": "Deployments are not allowed because of some reasons.",
+    	"recommended_actions": "Remove Deployment",
+    	"url": "https://cloud.google.com/blog/products/containers-kubernetes/kubernetes-best-practices-resource-requests-and-limits",
+    }
+    ```
+  
+All fields under `__rego_metadata__` are optional.
+
+| Field name         | Allowed values                      | Default value | In table           | In JSON          |
+| ------------------ | ------------------------------------| :-----------: | :----------------: |:---------------: |
+| id                 | Any characters                      | N/A           | :material-check:   | :material-check: |
+| title              | Any characters                      | N/A           | :material-check:   | :material-check: |
+| severity           | `LOW`, `MEDIUM`, `HIGH`, `CRITICAL` | UNKNOWN       | :material-check:   | :material-check: |
+| type               | Any characters                      | N/A           | :material-check:   | :material-check: |
+| description        | Any characters                      |               | :material-close:   | :material-check: |
+| recommended_actions| Any characters                      |               | :material-close:   | :material-check: | 
+| url                | Any characters                      |               | :material-close:   | :material-check: |
+
+Some fields are displayed in scan results.
+
+``` bash
+deployment.yaml (kubernetes)
+============================
+Tests: 28 (SUCCESSES: 14, FAILURES: 14, EXCEPTIONS: 0)
+Failures: 14 (HIGH: 1)
+
++---------------------------+------------+-------------------------------------+----------+------------------------------------------+
+|           TYPE            | MISCONF ID |                CHECK                | SEVERITY |                 MESSAGE                  |
++---------------------------+------------+-------------------------------------+----------+------------------------------------------+
+| Custom Kubernetes Check   |   ID001    | Deployment not allowed              |   LOW    | Found deployment 'test' but deployments  |
+|                           |            |                                     |          | are not allowed                          |
++---------------------------+------------+-------------------------------------+----------+------------------------------------------+
+```
+
+### Input
+You can specify input format via `__rego_input__`.
+All fields under `__rego_input` are optional.
+
+!!!example
+    ``` rego
+    __rego_input__ := {
+        "combine": false,
+        "selector": [
+            {"type": "kubernetes"},
+        ],
+    }
+    ```
+
+`combine` (boolean)
+: The details is [here](combine.md).
+
+`selector` (array)
+:   This option filters the input by file formats or configuration languages. 
+    In the above example, Trivy passes only Kubernetes files to this policy.
+    Even if Dockerfile exists in the specified directory, it will not be passed to the policy as input.
+
+    When configuration language such as Kubernetes is not identified, file format such as JSON will be used as `type`.
+    When configuration language is identified, it will overwrite `type`.
+    
+    !!! example
+        `pod.yaml` including Kubernetes Pod will be handled as `kubernetes`, not `yaml`.
+        `type` is overwritten by `kubernetes` from `yaml`.
+
+    `type` accepts `kubernetes`, `dockerfile`, `ansible`, `cloudformation`, `json`, `yaml`, `toml`, or `hcl`.
+
+[rego]: https://www.openpolicyagent.org/docs/latest/policy-language/
+[package]: https://www.openpolicyagent.org/docs/latest/policy-language/#packages

docs/misconfiguration/custom/testing.md

@@ -0,0 +1,90 @@
+# Testing
+It is highly recommended to write tests for your custom policies.
+
+## Rego testing
+To help you verify the correctness of your custom policies, OPA gives you a framework that you can use to write tests for your policies. 
+By writing tests for your custom policies you can speed up the development process of new rules and reduce the amount of time it takes to modify rules as requirements evolve.
+
+For more details, see [Policy Testing][opa-testing].
+
+!!! example
+    ```
+    package user.dockerfile.ID002
+
+    test_add_denied {
+        r := deny with input as {"stages": {"alpine:3.13": [
+            {"Cmd": "add", "Value": ["/target/resources.tar.gz", "resources.jar"]},
+            {"Cmd": "add", "Value": ["/target/app.jar", "app.jar"]},
+        ]}}
+
+        count(r) == 1
+        r[_] == "Consider using 'COPY /target/app.jar app.jar' command instead of 'ADD /target/app.jar app.jar'"
+    }
+    ```
+
+To write tests for custom policies, you can refer to existing tests under [AppShield][appshield].
+
+## Go testing
+[Fanal][fanal] which is a core library of Trivy can be imported as a Go library.
+You can scan config files in Go and test your custom policies using Go's testing methods, such as [table-driven tests][table].
+This allows you to use the actual configuration file as input, making it easy to prepare test data and ensure that your custom policies work in practice.
+
+In particular, Dockerfile and HCL need to be converted to structural data as input, which may be different from the expected input format.
+
+!!! tip
+    We recommend writing OPA and Go tests both since they have different roles, like unit tests and integration tests.
+
+The following example stores allowed and denied configuration files in a directory.
+`Successes` contains the result of successes, and `Failures` contains the result of failures.
+
+``` go
+{
+	name:  "disallowed ports",
+	input: "configs/",
+	fields: fields{
+		policyPaths: []string{"policy"},
+		dataPaths:   []string{"data"},
+		namespaces:  []string{"user"},
+	},
+	want: []types.Misconfiguration{
+		{
+			FileType: types.Dockerfile,
+			FilePath: "Dockerfile.allowed",
+			Successes: types.MisconfResults{
+				{
+					Namespace: "user.dockerfile.ID002",
+					PolicyMetadata: types.PolicyMetadata{
+						ID:          "ID002",
+						Type:        "Docker Custom Check",
+						Title:       "Disallowed ports exposed",
+						Severity:    "HIGH",
+					},
+				},
+			},
+		},
+		{
+			FileType: types.Dockerfile,
+			FilePath: "Dockerfile.denied",
+			Failures: types.MisconfResults{
+				{
+					Namespace: "user.dockerfile.ID002",
+					Message:   "Port 23 should not be exposed",
+					PolicyMetadata: types.PolicyMetadata{
+						ID:          "ID002",
+						Type:        "Docker Custom Check",
+						Title:       "Disallowed ports exposed",
+						Severity:    "HIGH",
+					},
+				},
+			},
+		},
+	},
+},
+```
+
+`Dockerfile.allowed` has one successful result in `Successes`, while `Dockerfile.denied` has one failure result in `Failures`.
+
+[opa-testing]: https://www.openpolicyagent.org/docs/latest/policy-testing/
+[appshield]: https://github.com/aquasecurity/appshield
+[table]: https://github.com/golang/go/wiki/TableDrivenTests
+[fanal]: https://github.com/aquasecurity/fanal

docs/misconfiguration/filesystem.md

@@ -0,0 +1,56 @@
+# Filesystem
+
+## Quick start
+
+Trivy scans a filesystem such as a virtual machine to detect misconfigurations.
+
+You have to specify `--security-checks config` to enable misconfiguration detection.
+
+```bash
+$ trivy fs --security-checks config /path/to/dir
+```
+
+Internally, it is the same as [config subcommand](iac.md).
+
+## Vulnerability and Misconfiguration scanning
+The difference between `fs` and `config` subcommand is that `fs` can detect both vulnerabilities and misconfiguration at the same time.
+
+You have to specify `--security-checks vuln,config` to enable vulnerability and misconfiguration detection.
+
+``` bash
+$ ls myapp/
+Dockerfile Pipfile.lock
+$ trivy fs --security-checks vuln,config --severity HIGH,CRITICAL myapp/
+2021-07-09T12:03:27.564+0300    INFO    Detected OS: unknown
+2021-07-09T12:03:27.564+0300    INFO    Number of language-specific files: 1
+2021-07-09T12:03:27.564+0300    INFO    Detecting pipenv vulnerabilities...
+2021-07-09T12:03:27.566+0300    INFO    Detected config files: 1
+
+Pipfile.lock (pipenv)
+=====================
+Total: 1 (HIGH: 1, CRITICAL: 0)
+
++----------+------------------+----------+-------------------+---------------+---------------------------------------+
+| LIBRARY  | VULNERABILITY ID | SEVERITY | INSTALLED VERSION | FIXED VERSION |                 TITLE                 |
++----------+------------------+----------+-------------------+---------------+---------------------------------------+
+| httplib2 | CVE-2021-21240   | HIGH     | 0.12.1            | 0.19.0        | python-httplib2: Regular              |
+|          |                  |          |                   |               | expression denial of                  |
+|          |                  |          |                   |               | service via malicious header          |
+|          |                  |          |                   |               | -->avd.aquasec.com/nvd/cve-2021-21240 |
++----------+------------------+----------+-------------------+---------------+---------------------------------------+
+
+Dockerfile (dockerfile)
+=======================
+Tests: 23 (SUCCESSES: 22, FAILURES: 1, EXCEPTIONS: 0)
+Failures: 1 (HIGH: 1, CRITICAL: 0)
+
++---------------------------+------------+----------------------+----------+------------------------------------------+
+|           TYPE            | MISCONF ID |        CHECK         | SEVERITY |                 MESSAGE                  |
++---------------------------+------------+----------------------+----------+------------------------------------------+
+| Dockerfile Security Check |   DS002    | Image user is 'root' |   HIGH   | Last USER command in                     |
+|                           |            |                      |          | Dockerfile should not be 'root'          |
+|                           |            |                      |          | -->avd.aquasec.com/appshield/ds002       |
++---------------------------+------------+----------------------+----------+------------------------------------------+
+```
+
+In the above example, Trivy detected vulnerabilities of Python dependencies and misconfigurations in Dockerfile.

docs/misconfiguration/iac.md

@@ -0,0 +1,163 @@
+# Infrastructure as Code (IaC)
+
+## Quick start
+
+Simply specify a directory containing IaC files such as Terraform, CloudFormation and Dockerfile.
+
+``` bash
+$ trivy config [YOUR_IaC_DIRECTORY]
+```
+
+Trivy will automatically fetch the managed policies and will keep them up-to-date in future scans.
+
+!!! example
+    ```
+    $ ls build/
+    Dockerfile
+    $ trivy config ./build
+    2021-07-09T10:06:29.188+0300    INFO    Need to update the built-in policies
+    2021-07-09T10:06:29.188+0300    INFO    Downloading the built-in policies...
+    2021-07-09T10:06:30.520+0300    INFO    Detected config files: 1
+    
+    Dockerfile (dockerfile)
+    =======================
+    Tests: 23 (SUCCESSES: 22, FAILURES: 1, EXCEPTIONS: 0)
+    Failures: 1 (UNKNOWN: 0, LOW: 0, MEDIUM: 0, HIGH: 1, CRITICAL: 0)
+    
+    +---------------------------+------------+----------------------+----------+------------------------------------------+
+    |           TYPE            | MISCONF ID |        CHECK         | SEVERITY |                 MESSAGE                  |
+    +---------------------------+------------+----------------------+----------+------------------------------------------+
+    | Dockerfile Security Check |   DS002    | Image user is 'root' |   HIGH   | Last USER command in                     |
+    |                           |            |                      |          | Dockerfile should not be 'root'          |
+    |                           |            |                      |          | -->avd.aquasec.com/appshield/ds002       |
+    +---------------------------+------------+----------------------+----------+------------------------------------------+
+    ```
+    
+## Type detection
+The specified directory can contain mixed types of IaC files.
+Trivy automatically detects config types and applies relevant policies.
+
+For example, the following example holds IaC files for Terraform, CloudFormation, Kubernetes, and Dockerfile in the same directory.
+
+``` bash
+$ ls iac/
+Dockerfile  deployment.yaml  main.tf
+$ trivy conf --severity HIGH,CRITICAL ./iac
+```
+
+<details>
+<summary>Result</summary>
+
+```
+2021-07-09T11:51:08.212+0300    INFO    Need to update the built-in policies
+2021-07-09T11:51:08.212+0300    INFO    Downloading the built-in policies...
+2021-07-09T11:51:09.527+0300    INFO    Detected config files: 3
+
+Dockerfile (dockerfile)
+=======================
+Tests: 23 (SUCCESSES: 22, FAILURES: 1, EXCEPTIONS: 0)
+Failures: 1 (HIGH: 1, CRITICAL: 0)
+
++---------------------------+------------+----------------------+----------+------------------------------------------+
+|           TYPE            | MISCONF ID |        CHECK         | SEVERITY |                 MESSAGE                  |
++---------------------------+------------+----------------------+----------+------------------------------------------+
+| Dockerfile Security Check |   DS002    | Image user is 'root' |   HIGH   | Last USER command in                     |
+|                           |            |                      |          | Dockerfile should not be 'root'          |
+|                           |            |                      |          | -->avd.aquasec.com/appshield/ds002       |
++---------------------------+------------+----------------------+----------+------------------------------------------+
+
+deployment.yaml (kubernetes)
+============================
+Tests: 28 (SUCCESSES: 15, FAILURES: 13, EXCEPTIONS: 0)
+Failures: 13 (HIGH: 1, CRITICAL: 0)
+
++---------------------------+------------+----------------------------+----------+------------------------------------------+
+|           TYPE            | MISCONF ID |           CHECK            | SEVERITY |                 MESSAGE                  |
++---------------------------+------------+----------------------------+----------+------------------------------------------+
+| Kubernetes Security Check |   KSV005   | SYS_ADMIN capability added |   HIGH   | Container 'hello-kubernetes' of          |
+|                           |            |                            |          | Deployment 'hello-kubernetes'            |
+|                           |            |                            |          | should not include 'SYS_ADMIN' in        |
+|                           |            |                            |          | 'securityContext.capabilities.add'       |
+|                           |            |                            |          | -->avd.aquasec.com/appshield/ksv005      |
++---------------------------+------------+----------------------------+----------+------------------------------------------+
+
+main.tf (terraform)
+===================
+Tests: 23 (SUCCESSES: 14, FAILURES: 9, EXCEPTIONS: 0)
+Failures: 9 (HIGH: 6, CRITICAL: 1)
+
++------------------------------------------+------------+------------------------------------------+----------+--------------------------------------------------------+
+|                   TYPE                   | MISCONF ID |                  CHECK                   | SEVERITY |                        MESSAGE                         |
++------------------------------------------+------------+------------------------------------------+----------+--------------------------------------------------------+
+|   Terraform Security Check powered by    |   AWS003   | AWS Classic resource usage.              |   HIGH   | Resource                                               |
+|                  tfsec                   |            |                                          |          | 'aws_db_security_group.my-group'                       |
+|                                          |            |                                          |          | uses EC2 Classic. Use a VPC instead.                   |
+|                                          |            |                                          |          | -->tfsec.dev/docs/aws/AWS003/                          |
++                                          +------------+------------------------------------------+----------+--------------------------------------------------------+
+|                                          |   AWS004   | Use of plain HTTP.                       | CRITICAL | Resource                                               |
+|                                          |            |                                          |          | 'aws_alb_listener.my-alb-listener'                     |
+|                                          |            |                                          |          | uses plain HTTP instead of HTTPS.                      |
+|                                          |            |                                          |          | -->tfsec.dev/docs/aws/AWS004/                          |
++                                          +------------+------------------------------------------+----------+--------------------------------------------------------+
+|                                          |   AWS018   | Missing description for security         |   HIGH   | Resource                                               |
+|                                          |            | group/security group rule.               |          | 'aws_security_group_rule.my-rule' should               |
+|                                          |            |                                          |          | include a description for auditing                     |
+|                                          |            |                                          |          | purposes. -->tfsec.dev/docs/aws/AWS018/                |
++                                          +------------+------------------------------------------+          +--------------------------------------------------------+
+|                                          |   AWS025   | API Gateway domain name uses outdated    |          | Resource                                               |
+|                                          |            | SSL/TLS protocols.                       |          | 'aws_api_gateway_domain_name.empty_security_policy'    |
+|                                          |            |                                          |          | defines outdated SSL/TLS policies (not using           |
+|                                          |            |                                          |          | TLS_1_2). -->tfsec.dev/docs/aws/AWS025/                |
++                                          +            +                                          +          +--------------------------------------------------------+
+|                                          |            |                                          |          | Resource                                               |
+|                                          |            |                                          |          | 'aws_api_gateway_domain_name.missing_security_policy'  |
+|                                          |            |                                          |          | should include security_policy (defauls to outdated    |
+|                                          |            |                                          |          | SSL/TLS policy). -->tfsec.dev/docs/aws/AWS025/         |
++                                          +            +                                          +          +--------------------------------------------------------+
+|                                          |            |                                          |          | Resource                                               |
+|                                          |            |                                          |          | 'aws_api_gateway_domain_name.outdated_security_policy' |
+|                                          |            |                                          |          | defines outdated SSL/TLS policies (not using TLS_1_2). |
+|                                          |            |                                          |          | -->tfsec.dev/docs/aws/AWS025/                          |
++                                          +------------+------------------------------------------+          +--------------------------------------------------------+
+|                                          |   AZU003   | Unencrypted managed disk.                |          | Resource 'azurerm_managed_disk.source'                 |
+|                                          |            |                                          |          | defines an unencrypted managed disk.                   |
+|                                          |            |                                          |          | -->tfsec.dev/docs/azure/AZU003/                        |
++------------------------------------------+------------+------------------------------------------+----------+--------------------------------------------------------+
+```
+
+</details>
+
+You can see the config type next to each file name.
+
+!!! example
+    ``` bash
+    Dockerfile (dockerfile)
+    =======================
+    Tests: 23 (SUCCESSES: 22, FAILURES: 1, EXCEPTIONS: 0)
+    Failures: 1 (HIGH: 1, CRITICAL: 0)
+    
+    ...
+    
+    deployment.yaml (kubernetes)
+    ============================
+    Tests: 28 (SUCCESSES: 15, FAILURES: 13, EXCEPTIONS: 0)
+    Failures: 13 (HIGH: 1, CRITICAL: 0)
+    
+    ...
+    
+    main.tf (terraform)
+    ===================
+    Tests: 23 (SUCCESSES: 14, FAILURES: 9, EXCEPTIONS: 0)
+    Failures: 9 (HIGH: 6, CRITICAL: 1)
+
+    ...
+
+    bucket.yaml (cloudformation)
+    ============================
+    Tests: 9 (SUCCESSES: 3, FAILURES: 6, EXCEPTIONS: 0)
+    Failures: 6 (UNKNOWN: 0, LOW: 0, MEDIUM: 2, HIGH: 4, CRITICAL: 0)
+
+    ```
+
+## Example
+See [here](https://github.com/aquasecurity/trivy/tree/125c457517f05b6498bc68eaeec6e683dd36c49a/examples/misconf/mixed)

docs/misconfiguration/index.md

@@ -0,0 +1,8 @@
+# Misconfiguration Scanning
+Trivy provides built-in policies to detect configuration issues in Docker, Kubernetes and Terraform.
+Also, you can write your own policies in [Rego][rego] to scan JSON, YAML, HCL, etc, like [Conftest][conftest].
+
+![misconf](../imgs/misconf.png)
+
+[rego]: https://www.openpolicyagent.org/docs/latest/policy-language/
+[conftest]: https://github.com/open-policy-agent/conftest/

docs/misconfiguration/options/filter.md

@@ -0,0 +1,212 @@
+# Filter Misconfigurations
+
+## By Severity
+
+Use `--severity` option.
+
+```bash
+trivy conf --severity HIGH,CRITICAL examples/misconf/mixed
+```
+
+<details>
+<summary>Result</summary>
+
+```bash
+2021-07-10T17:37:13.267+0300    INFO    Detected config files: 4
+
+configs/Dockerfile (dockerfile)
+===============================
+Tests: 23 (SUCCESSES: 21, FAILURES: 2, EXCEPTIONS: 0)
+Failures: 2 (HIGH: 1, CRITICAL: 0)
+
++---------------------------+------------+----------------------+----------+------------------------------------------+
+|           TYPE            | MISCONF ID |        CHECK         | SEVERITY |                 MESSAGE                  |
++---------------------------+------------+----------------------+----------+------------------------------------------+
+| Dockerfile Security Check |   DS002    | Image user is 'root' |   HIGH   | Specify at least 1 USER                  |
+|                           |            |                      |          | command in Dockerfile with               |
+|                           |            |                      |          | non-root user as argument                |
+|                           |            |                      |          | -->avd.aquasec.com/appshield/ds002       |
++---------------------------+------------+----------------------+----------+------------------------------------------+
+
+configs/deployment.yaml (kubernetes)
+====================================
+Tests: 28 (SUCCESSES: 14, FAILURES: 14, EXCEPTIONS: 0)
+Failures: 14 (HIGH: 1, CRITICAL: 0)
+
++---------------------------+------------+-------------------------------------+----------+------------------------------------------+
+|           TYPE            | MISCONF ID |                CHECK                | SEVERITY |                 MESSAGE                  |
++---------------------------+------------+-------------------------------------+----------+------------------------------------------+
+| Kubernetes Security Check |   KSV006   | docker.sock is mounted to container |   HIGH   | Deployment 'hello-kubernetes' should     |
+|                           |            |                                     |          | not specify '/var/run/docker.socker' in  |
+|                           |            |                                     |          | 'spec.template.volumes.hostPath.path'    |
+|                           |            |                                     |          | -->avd.aquasec.com/appshield/ksv006      |
++---------------------------+------------+-------------------------------------+----------+------------------------------------------+
+
+configs/main.tf (terraform)
+===========================
+Tests: 19 (SUCCESSES: 11, FAILURES: 8, EXCEPTIONS: 0)
+Failures: 8 (HIGH: 6, CRITICAL: 1)
+
++------------------------------------------+------------+------------------------------------------+----------+--------------------------------------------------------+
+|                   TYPE                   | MISCONF ID |                  CHECK                   | SEVERITY |                        MESSAGE                         |
++------------------------------------------+------------+------------------------------------------+----------+--------------------------------------------------------+
+|   Terraform Security Check powered by    |   AWS003   | AWS Classic resource usage.              |   HIGH   | Resource                                               |
+|                  tfsec                   |            |                                          |          | 'aws_db_security_group.my-group'                       |
+|                                          |            |                                          |          | uses EC2 Classic. Use a VPC instead.                   |
+|                                          |            |                                          |          | -->tfsec.dev/docs/aws/AWS003/                          |
++                                          +------------+------------------------------------------+----------+--------------------------------------------------------+
+|                                          |   AWS004   | Use of plain HTTP.                       | CRITICAL | Resource                                               |
+|                                          |            |                                          |          | 'aws_alb_listener.my-alb-listener'                     |
+|                                          |            |                                          |          | uses plain HTTP instead of HTTPS.                      |
+|                                          |            |                                          |          | -->tfsec.dev/docs/aws/AWS004/                          |
++                                          +------------+------------------------------------------+----------+--------------------------------------------------------+
+|                                          |   AWS018   | Missing description for security         |   HIGH   | Resource                                               |
+|                                          |            | group/security group rule.               |          | 'aws_security_group_rule.my-rule' should               |
+|                                          |            |                                          |          | include a description for auditing                     |
+|                                          |            |                                          |          | purposes. -->tfsec.dev/docs/aws/AWS018/                |
++                                          +------------+------------------------------------------+          +--------------------------------------------------------+
+|                                          |   AWS025   | API Gateway domain name uses outdated    |          | Resource                                               |
+|                                          |            | SSL/TLS protocols.                       |          | 'aws_api_gateway_domain_name.empty_security_policy'    |
+|                                          |            |                                          |          | defines outdated SSL/TLS policies (not using           |
+|                                          |            |                                          |          | TLS_1_2). -->tfsec.dev/docs/aws/AWS025/                |
++                                          +            +                                          +          +--------------------------------------------------------+
+|                                          |            |                                          |          | Resource                                               |
+|                                          |            |                                          |          | 'aws_api_gateway_domain_name.missing_security_policy'  |
+|                                          |            |                                          |          | should include security_policy (defauls to outdated    |
+|                                          |            |                                          |          | SSL/TLS policy). -->tfsec.dev/docs/aws/AWS025/         |
++                                          +            +                                          +          +--------------------------------------------------------+
+|                                          |            |                                          |          | Resource                                               |
+|                                          |            |                                          |          | 'aws_api_gateway_domain_name.outdated_security_policy' |
+|                                          |            |                                          |          | defines outdated SSL/TLS policies (not using TLS_1_2). |
+|                                          |            |                                          |          | -->tfsec.dev/docs/aws/AWS025/                          |
++                                          +------------+------------------------------------------+          +--------------------------------------------------------+
+|                                          |   AZU003   | Unencrypted managed disk.                |          | Resource 'azurerm_managed_disk.source'                 |
+|                                          |            |                                          |          | defines an unencrypted managed disk.                   |
+|                                          |            |                                          |          | -->tfsec.dev/docs/azure/AZU003/                        |
++------------------------------------------+------------+------------------------------------------+----------+--------------------------------------------------------+
+
+configs/variables.tf (terraform)
+================================
+Tests: 1 (SUCCESSES: 1, FAILURES: 0, EXCEPTIONS: 0)
+Failures: 0 (HIGH: 0, CRITICAL: 0)
+```
+
+</details>
+
+## By Misconfiguration IDs
+
+Use `.trivyignore`.
+
+```bash
+$ cat .trivyignore
+# Accept the risk
+AWS003
+AWS018
+AWS025
+
+$ trivy conf --severity HIGH,CRITICAL examples/misconf/mixed
+```
+
+<details>
+<summary>Result</summary>
+
+```bash
+2021-07-10T17:38:51.306+0300    INFO    Detected config files: 4
+
+configs/Dockerfile (dockerfile)
+===============================
+Tests: 23 (SUCCESSES: 21, FAILURES: 2, EXCEPTIONS: 0)
+Failures: 2 (HIGH: 1, CRITICAL: 0)
+
++---------------------------+------------+----------------------+----------+------------------------------------------+
+|           TYPE            | MISCONF ID |        CHECK         | SEVERITY |                 MESSAGE                  |
++---------------------------+------------+----------------------+----------+------------------------------------------+
+| Dockerfile Security Check |   DS002    | Image user is 'root' |   HIGH   | Specify at least 1 USER                  |
+|                           |            |                      |          | command in Dockerfile with               |
+|                           |            |                      |          | non-root user as argument                |
+|                           |            |                      |          | -->avd.aquasec.com/appshield/ds002       |
++---------------------------+------------+----------------------+----------+------------------------------------------+
+
+configs/deployment.yaml (kubernetes)
+====================================
+Tests: 28 (SUCCESSES: 14, FAILURES: 14, EXCEPTIONS: 0)
+Failures: 14 (HIGH: 1, CRITICAL: 0)
+
++---------------------------+------------+-------------------------------------+----------+------------------------------------------+
+|           TYPE            | MISCONF ID |                CHECK                | SEVERITY |                 MESSAGE                  |
++---------------------------+------------+-------------------------------------+----------+------------------------------------------+
+| Kubernetes Security Check |   KSV006   | docker.sock is mounted to container |   HIGH   | Deployment 'hello-kubernetes' should     |
+|                           |            |                                     |          | not specify '/var/run/docker.socker' in  |
+|                           |            |                                     |          | 'spec.template.volumes.hostPath.path'    |
+|                           |            |                                     |          | -->avd.aquasec.com/appshield/ksv006      |
++---------------------------+------------+-------------------------------------+----------+------------------------------------------+
+
+configs/main.tf (terraform)
+===========================
+Tests: 19 (SUCCESSES: 11, FAILURES: 8, EXCEPTIONS: 0)
+Failures: 8 (HIGH: 1, CRITICAL: 1)
+
++------------------------------------------+------------+---------------------------+----------+------------------------------------------+
+|                   TYPE                   | MISCONF ID |           CHECK           | SEVERITY |                 MESSAGE                  |
++------------------------------------------+------------+---------------------------+----------+------------------------------------------+
+|   Terraform Security Check powered by    |   AWS004   | Use of plain HTTP.        | CRITICAL | Resource                                 |
+|                  tfsec                   |            |                           |          | 'aws_alb_listener.my-alb-listener'       |
+|                                          |            |                           |          | uses plain HTTP instead of HTTPS.        |
+|                                          |            |                           |          | -->tfsec.dev/docs/aws/AWS004/            |
++                                          +------------+---------------------------+----------+------------------------------------------+
+|                                          |   AZU003   | Unencrypted managed disk. |   HIGH   | Resource 'azurerm_managed_disk.source'   |
+|                                          |            |                           |          | defines an unencrypted managed disk.     |
+|                                          |            |                           |          | -->tfsec.dev/docs/azure/AZU003/          |
++------------------------------------------+------------+---------------------------+----------+------------------------------------------+
+
+configs/variables.tf (terraform)
+================================
+Tests: 1 (SUCCESSES: 1, FAILURES: 0, EXCEPTIONS: 0)
+Failures: 0 (HIGH: 0, CRITICAL: 0)
+```
+
+</details>
+
+## By Exceptions
+See [Exceptions](../policy/exceptions.md)
+
+## Show Successes and Exceptions
+Use `--include-non-failures` option to show successes and exceptions as well as failures.
+
+```bash
+trivy conf --severity CRITICAL --include-non-failures examples/misconf/mixed
+```
+
+<details>
+<summary>Result</summary>
+```
+2021-07-10T17:44:02.049+0300    INFO    Detected config files: 4
+
+configs/Dockerfile (dockerfile)
+===============================
+Tests: 23 (SUCCESSES: 21, FAILURES: 2, EXCEPTIONS: 0)
+Failures: 2 (CRITICAL: 0)
+
++---------------------------+------------+------------------------------------------+----------+--------+-----------------+
+|           TYPE            | MISCONF ID |                  CHECK                   | SEVERITY | STATUS |     MESSAGE     |
++---------------------------+------------+------------------------------------------+----------+--------+-----------------+
+| Dockerfile Security Check |   DS006    | COPY '--from' refers to the current      | CRITICAL |  PASS  | No issues found |
+|                           |            | image                                    |          |        |                 |
++                           +------------+------------------------------------------+          +        +                 +
+|                           |   DS007    | Multiple ENTRYPOINT instructions are     |          |        |                 |
+|                           |            | listed                                   |          |        |                 |
++                           +------------+------------------------------------------+          +        +                 +
+|                           |   DS008    | Exposed port is out of range             |          |        |                 |
++                           +------------+------------------------------------------+          +        +                 +
+|                           |   DS010    | 'sudo' is used                           |          |        |                 |
++                           +------------+------------------------------------------+          +        +                 +
+|                           |   DS011    | COPY with more than two arguments is not |          |        |                 |
+|                           |            | ending with slash                        |          |        |                 |
++                           +------------+------------------------------------------+          +        +                 +
+|                           |   DS012    | Duplicate aliases are defined in         |          |        |                 |
+|                           |            | different FROMs                          |          |        |                 |
++---------------------------+------------+------------------------------------------+----------+--------+-----------------+
+
+...
+```
+</details>

docs/misconfiguration/options/others.md

@@ -0,0 +1,22 @@
+# Others
+
+!!! hint
+    See also [Others](../../vulnerability/examples/others.md) in Vulnerability section.
+
+## File patterns
+When a directory is given as an input, Trivy will recursively look for and test all files based on file patterns.
+The default file patterns are [here](../custom/index.md).
+
+In addition to the default file patterns, the `--file-patterns` option takes regexp patterns to look for your files.
+For example, it may be useful when your file name of Dockerfile doesn't match the default patterns.
+
+This can be repeated for specifying multiple file patterns.
+Allowed values are here:
+
+- dockerfile
+- yaml
+- json
+- toml
+- hcl
+
+For more details, see [an example](https://github.com/aquasecurity/trivy/tree/{{ git.commit }}/examples/misconf/file-patterns)

docs/misconfiguration/options/policy.md

@@ -0,0 +1,88 @@
+# Policy
+
+## Pass custom policies
+You can pass directories including your custom policies through `--policy` option.
+This can be repeated for specifying multiple directories.
+
+```bash
+cd examplex/misconf/
+trivy conf --policy custom-policy/policy --policy combine/policy --namespaces user misconf/mixed
+```
+
+For more details, see [Custom Policies](../custom/index.md).
+
+!!! tip
+    You also need to specify `--namespaces` option.
+
+## Pass custom data
+You can pass directories including your custom data through `--data` option.
+This can be repeated for specifying multiple directories.
+
+```bash
+cd examples/misconf/custom-data
+trivy conf --policy ./policy --data ./data --namespaces user ./configs
+```
+
+For more details, see [Custom Data](../custom/data.md).
+
+## Pass namespaces
+By default, Trivy evaluate policies defined in `appshield.*`.
+If you want to evaluate custom policies in other packages, you have to specify package prefixes through `--namespaces` option.
+This can be repeated for specifying multiple packages.
+
+``` bash
+trivy conf --policy ./policy --namespaces main --namespaces user ./configs
+```
+
+## Skip update of built-in policies
+`Trivy` downloads built-in policies when it starts operating.
+Then, it checks for updates every 24 hours.
+You can use the `--skip-policy-update` option to skip it.
+If you skip it the first time, the built-in policies will not be loaded.
+
+!!! note
+    Even if you specify the option the first time, it will be loaded as Terraform policies are written in Go.
+
+```
+trivy conf --skip-policy-update examples/misconf/mixed                                                                                           [~/src/github.com/aquasecurity/trivy]
+
+```
+
+<details>
+<summary>Result</summary>
+
+```
+2021-07-10T18:04:19.083+0300    INFO    No builtin policies were loaded
+2021-07-10T18:04:19.174+0300    INFO    Detected config files: 2
+
+configs/main.tf (terraform)
+===========================
+Tests: 19 (SUCCESSES: 11, FAILURES: 8, EXCEPTIONS: 0)
+Failures: 8 (UNKNOWN: 0, LOW: 0, MEDIUM: 1, HIGH: 1, CRITICAL: 1)
+
++------------------------------------------+------------+------------------------------------------+----------+------------------------------------------+
+|                   TYPE                   | MISCONF ID |                  CHECK                   | SEVERITY |                 MESSAGE                  |
++------------------------------------------+------------+------------------------------------------+----------+------------------------------------------+
+|   Terraform Security Check powered by    |   AWS004   | Use of plain HTTP.                       | CRITICAL | Resource                                 |
+|                  tfsec                   |            |                                          |          | 'aws_alb_listener.my-alb-listener'       |
+|                                          |            |                                          |          | uses plain HTTP instead of HTTPS.        |
+|                                          |            |                                          |          | -->tfsec.dev/docs/aws/AWS004/            |
++                                          +------------+------------------------------------------+----------+------------------------------------------+
+|                                          |   AWS006   | An ingress security group rule allows    |  MEDIUM  | Resource                                 |
+|                                          |            | traffic from /0.                         |          | 'aws_security_group_rule.my-rule'        |
+|                                          |            |                                          |          | defines a fully open                     |
+|                                          |            |                                          |          | ingress security group rule.             |
+|                                          |            |                                          |          | -->tfsec.dev/docs/aws/AWS006/            |
++                                          +------------+------------------------------------------+----------+------------------------------------------+
+|                                          |   AZU003   | Unencrypted managed disk.                |   HIGH   | Resource 'azurerm_managed_disk.source'   |
+|                                          |            |                                          |          | defines an unencrypted managed disk.     |
+|                                          |            |                                          |          | -->tfsec.dev/docs/azure/AZU003/          |
++------------------------------------------+------------+------------------------------------------+----------+------------------------------------------+
+
+configs/variables.tf (terraform)
+================================
+Tests: 1 (SUCCESSES: 1, FAILURES: 0, EXCEPTIONS: 0)
+Failures: 0 (UNKNOWN: 0, LOW: 0, MEDIUM: 0, HIGH: 0, CRITICAL: 0)
+```
+</details>
+

docs/misconfiguration/options/report.md

@@ -0,0 +1,6 @@
+# Report Formats
+
+See [Reports Formats](../../vulnerability/examples/report.md) in Vulnerability section.
+
+!!! caution
+    Misconfiguration scanning doesn't support default templates such as XML and SARIF for now.

docs/misconfiguration/policy/builtin.md

@@ -0,0 +1,41 @@
+# Built-in Policies
+
+## Policy Sources
+
+Built-in policies are mainly written in [Rego][rego].
+Those policies are managed under [AppShield repository][appshield].
+Terraform policies are currently powered by [tfsec][tfsec] and CloudFormation policies are powered by [cfsec][cfsec].
+
+| Config type    | Source                        |
+| ---------------| ----------------------------- |
+| Kubernetes     | [AppShield][kubernetes]       |
+| Dockerfile     | [AppShield][docker]           |
+| Terraform      | [tfsec][tfsec-checks]         |
+| CloudFormation | [cfsec][cfsec-checks]         |
+
+For suggestions or issues regarding policy content, please open an issue under [AppShield][appshield], [tfsec][tfsec] or [cfsec][cfsec] repository.
+
+Ansible are coming soon.
+
+## Policy Distribution
+AppShield policies are distributed as an OPA bundle on [GitHub Container Registry][ghcr] (GHCR).
+When misconfiguration detection is enabled, Trivy pulls the OPA bundle from GHCR as an OCI artifact and stores it in the cache.
+Those policies are then loaded into Trivy OPA engine and used for detecting misconfigurations.
+
+## Update Interval
+Trivy checks for updates to OPA bundle on GHCR every 24 hours and pulls it if there are any updates.
+
+[rego]: https://www.openpolicyagent.org/docs/latest/policy-language/
+[appshield]: https://github.com/aquasecurity/appshield
+[kubernetes]: https://github.com/aquasecurity/appshield/tree/master/kubernetes
+[docker]: https://github.com/aquasecurity/appshield/tree/master/docker
+[tfsec-checks]: https://tfsec.dev/docs/aws/home/
+[tfsec]: https://github.com/aquasecurity/tfsec
+[cfsec-checks]: https://cfsec.dev/
+[cfsec]: https://github.com/aquasecurity/cfsec
+[ghcr]: https://github.com/aquasecurity/appshield/pkgs/container/appshield
+
+[dockerfile-bestpractice]: https://docs.docker.com/develop/develop-images/dockerfile_best-practices/
+[pss]: https://kubernetes.io/docs/concepts/security/pod-security-standards/
+[azure]: https://docs.microsoft.com/en-us/azure/security/fundamentals/network-best-practices
+[kics]: https://github.com/Checkmarx/kics/

docs/misconfiguration/policy/exceptions.md

@@ -0,0 +1,98 @@
+# Exceptions
+Exceptions lets you to specify cases where you allow policy violations.
+Trivy supports two types of exceptions.
+
+!!! info
+    Exceptions can be applied to built-in policies as well as custom policies.
+
+## Namespace-based exceptions
+There are some cases where you need to disable built-in policies partially or fully.
+Namespace-based exceptions lets you rough choose which individual packages to exempt.
+
+To use namespace-based exceptions, create a Rego rule with the name `exception` that returns the package names to exempt.
+The `exception` rule must be defined under `namespace.exceptions`.
+`data.namespaces` includes all package names.
+
+
+!!! example
+    ``` rego
+    package namespace.exceptions
+
+    import data.namespaces
+        
+    exception[ns] {
+        ns := data.namespaces[_]
+        startswith(ns, "appshield")
+    }
+    ```
+
+This example exempts all built-in policies for Kubernetes.
+
+For more details, see [an example][ns-example].
+
+## Rule-based exceptions
+There are some cases where you need more flexibility and granularity in defining which cases to exempt.
+Rule-based exceptions lets you granularly choose which individual rules to exempt, while also declaring under which conditions to exempt them.
+
+To use rule-based exceptions, create a Rego rule with the name `exception` that returns the rule name suffixes to exempt, prefixed by `deny_` (for example, returning `foo` will exempt `deny_foo`). 
+The rule can make any other assertion, for example, on the input or data documents. 
+This is useful to specify the exemption for a specific case.
+
+Note that if you specify the empty string, the exception will match all rules named `deny`.
+
+```
+exception[rules] {
+    # Logic
+
+    rules = ["foo","bar"]
+}
+```
+
+The above would provide an exception from `deny_foo` and `deny_bar`.
+
+
+!!! example
+    ```
+    package user.kubernetes.ID100
+
+    __rego_metadata := {
+        "id": "ID100",
+        "title": "Deployment not allowed",
+        "severity": "HIGH",
+        "type": "Kubernetes Custom Check",
+    }
+    
+    deny_deployment[msg] {
+        input.kind == "Deployment"
+    	msg = sprintf("Found deployment '%s' but deployments are not allowed", [name])
+    }
+    
+    exception[rules] {
+        input.kind == "Deployment"
+        input.metadata.name == "allow-deployment"
+        
+        rules := ["deployment"]
+    }
+    ```
+
+If you want to apply rule-based exceptions to built-in policies, you have to define the exception under the same package.
+
+!!! example
+    ``` rego
+    package appshield.kubernetes.KSV012
+
+    exception[rules] {
+        input.metadata.name == "can-run-as-root"
+        rules := [""]
+    }
+    ```
+
+This exception is applied to [KSV012][ksv012] in AppShield.
+You can get the package names in [AppShield repository][appshield] or the JSON output from Trivy.
+
+For more details, see [an example][rule-example].
+
+[ns-example]: https://github.com/aquasecurity/trivy/tree/{{ git.commit }}/examples/misconf/namespace-exception
+[rule-example]: https://github.com/aquasecurity/trivy/tree/{{ git.commit }}/examples/misconf/rule-exception
+[ksv012]: https://github.com/aquasecurity/appshield/blob/57bccc1897b2500a731415bda3990b0d4fbc959e/kubernetes/policies/pss/restricted/3_runs_as_root.rego
+[appshield]: https://github.com/aquasecurity/appshield/

docs/private-registries/gcr.md

@@ -1,7 +0,0 @@
-Trivy uses Google Cloud SDK. You don't need to install `gcloud` command.
-
-If you want to use target project's repository, you can settle via `GOOGLE_APPLICATION_CREDENTIAL`.
-```bash
-# must set TRIVY_USERNAME empty char
-export GOOGLE_APPLICATION_CREDENTIALS=/path/to/credential.json
-```

docs/quickstart.md

@@ -1,34 +0,0 @@
-# Quick Start
-
-Simply specify an image name (and a tag).
-
-```
-$ trivy image [YOUR_IMAGE_NAME]
-```
-
-For example:
-
-```
-$ trivy image python:3.4-alpine
-```
-
-<details>
-<summary>Result</summary>
-
-```
-2019-05-16T01:20:43.180+0900    INFO    Updating vulnerability database...
-2019-05-16T01:20:53.029+0900    INFO    Detecting Alpine vulnerabilities...
-
-python:3.4-alpine3.9 (alpine 3.9.2)
-===================================
-Total: 1 (UNKNOWN: 0, LOW: 0, MEDIUM: 1, HIGH: 0, CRITICAL: 0)
-
-+---------+------------------+----------+-------------------+---------------+--------------------------------+
-| LIBRARY | VULNERABILITY ID | SEVERITY | INSTALLED VERSION | FIXED VERSION |             TITLE              |
-+---------+------------------+----------+-------------------+---------------+--------------------------------+
-| openssl | CVE-2019-1543    | MEDIUM   | 1.1.1a-r1         | 1.1.1b-r1     | openssl: ChaCha20-Poly1305     |
-|         |                  |          |                   |               | with long nonces               |
-+---------+------------------+----------+-------------------+---------------+--------------------------------+
-```
-
-</details>

docs/scanning/index.md

@@ -1,7 +0,0 @@
-# Scanning
-
-Trivy can be used to scan 
-
-- [Container Images](image.md)
-- [Filesystem](filesystem.md)
-- [Git Repositores](git-repository.md)