Skip to content

Latest commit

 

History

History
134 lines (87 loc) · 4.12 KB

README.md

File metadata and controls

134 lines (87 loc) · 4.12 KB
Raw

trivy buildkite plugin

The trivy buildkite plugin provides a convenient mechanism for running the open-source trivy static analysis tool on your project. For more information about trivy, please refer to their documentation.

Features

  • Automatically downloads and verifies the trivy executable if it cannot be found in the PATH environment variable's directories
  • Executes a filesystem scan on the git repo cloned by buildkite. Refer to the filesystem scan documentation for more information
  • Executes an image scan against an existing Docker image ref. Refer to the image scan documentation for more information

Basic example

The following code snippet demonstrates how to use the plugin in a pipeline step with the default plugin configuration parameters:

steps:
  - command: ls
    plugins:
      - equinixmetal-buildkite/trivy#v1.18.4:

Additional examples

Specify the --exit-code option as a plugin parameter in pipeline.yml to fail the pipeline when there are vulnerabilities:

steps:
  - command: ls
    plugins:
      - equinixmetal-buildkite/trivy#v1.18.4:
          exit-code: 1

Specify the --severity option as a plugin parameter in pipeline.yml to scan specific type of vulnerabilities. Below is an example for scanning CRITICAL vulnerabilities:

steps:
  - command: ls
    plugins:
      - equinixmetal-buildkite/trivy#v1.18.4:
          severity: "CRITICAL"

Configuration

exit-code (Optional, integer)

Controls whether the security scan is blocking or not. This is done by setting the exit code of the plugin. If the exit code is set to 0, the pipeline will continue. If the exit code is set to 1, the pipeline will fail. (Defaults to 0)

timeout (Optional, string)

Controls the maximum amount of time a scan will run for by passing the --timeout argument to trivy.

severity (Optional, string)

Controls the severity of the vulnerabilities to be scanned. (Defaults to "UNKNOWN,LOW,MEDIUM,HIGH,CRITICAL")

ignore-unfixed (Optional, boolean)

Controls whether to display only fixed vulnerabilities. (Defaults to false)

security-checks (Optional, string) (DEPRECATED)

Controls the security checks to be performed. This option is deprecated and may be removed in the future. Use scanners instead. (Defaults to "vuln,misconfig")

scanners (Optional, string)

Controls the security scanners to be used. This replaced security-checks (Defaults to "vuln,misconfig")

skip-files (Optional, string)

Controls the files to be skipped during the scan. (Defaults to "")

skip-dirs (Optional, string)

Controls the directories to be skipped during the scan. (Defaults to "")

image-ref (Optional, string)

Important: Please ensure the target Docker image is built prior to the trivy plugin running when using this option. The trivy plugin does not build Docker images; it only scans existing images.

Controls the image reference to be scanned. If no image is specified, the image scanning step is skipped. This is also able to infer the image from the docker-metadata plugin. (Defaults to "")

trivy-version (Optional, string)

Controls the version of trivy to be used.

helm-overrides-file (Optional, string)

To pass helm override values to trivy config scan

debug (Optional, boolean)

Enable debug flag for trivy.

Developing

To run the tests:

make test

Run the tests with debug logging enabled:

TEST_DEBUG=1 make test

To enable debug logging for a stubbed command in the test, you need to set or uncomment the export for the necessary command in the .bats file.

e.g. to view the debug logging for the trivy command, set the following at the top of the .bats file:

export TRIVY_STUB_DEBUG=/dev/tty

and then run the tests with debug logging enabled:

TEST_DEBUG=1 make test