Warning: Anchore Inline Scan, which is utilized for this integration, is deprecated. Please update your integrations to use Grype for CI-based vulnerability scanning or Syft.
After Jan 10, 2022: users should be transitioned to Grype or Grype-based integrations.
Anchore Task Extensions for Azure DevOps Pipelines
This is an Azure DevOps Pipeline task for scanning locally built images using Anchore Engine. It is used to scan container images and will return the vulnerabilities found, a software bill of materials, and the result of a policy evaluation. The task can be provided a custom policy which can be used to fail the pipeline if so desired.
No data is sent to a remote service to execute the scan, and no credentials are required
The vulnerability data comes from sources such as RedHat, Debian, Alpine, etc. All of this vulnerability data is packaged with the Anchore container that is used in the Anchore task. This means no external connections are required to sync vulnerability data when Anchore runs. The only external connection that is needed will be the connection to pull the Anchore image itself.
By default, the Anchore task will simply scan a local image using Anchore Engine and will provide files that contain a list of all the contents in the image as well as a list of all the vulnerabilities detected by Anchore. Both of these files will be output as pipeline variables along with the result of the policy evaluation. Under default behavior, the pipeline will not fail when the container does not pass the Anchore policy scan. The fail result will be published as a variable in the pipeline and can be used in subsequent tasks.
Note: While the dockerfile option is not required, it is recommended if the Dockerfile is available as it adds metadata for Anchore Engine.
Example yaml:
- task: Anchore@0
inputs:
image: 'localbuild/imagename:tag'
dockerfile: 'Dockerfile'
By default, the Anchore task will not fail the pipeline if the policy scan
returns a fail result. This is by design; however if you wish to stop the
pipeline when Anchore detects severe vulnerabilities or the container does not
pass policy then set the failBuild option to true.
Example yaml:
- task: Anchore@0
inputs:
image: 'localbuild/imagename:tag'
dockerfile: 'Dockerfile'
failBuild: true
If this option is set and the container does not pass policy, the build will fail and the following variables will be published:
billOfMaterials- the path to the bill of materials json filevulnerabilities- the path to the vulnerabilities json filepolicyCheck- the result (pass/fail) of the Anchore policy scan
By default, the Anchore task uses an image which will only find vulnerabilities
in OS packages (rpms, dpkg, apk, etc). This version of the Anchore image is
much smaller and therefore results in a faster scan. If you wish to find
vulnerabilities in application packages (npm, gems, pip, etc) then set the
includeAppPackages input to true. The resulting scan will take longer, but
it will produce a more thorough output of the vulnerabilities in the container.
Example yaml:
- task: Anchore@0
inputs:
image: 'localbuild/imagename:tag'
dockerfile: 'Dockerfile'
failBuild: true
includeAppPackages: true
When the Anchore task runs, it will use a default policy that is bundled with
the scanner. If you wish to use your own custom policy then simply use the
customPolicyPath. Supply the customPolicyPath input with the path to your
policy and Anchore will use it to scan your image.
Example yaml:
- task: Anchore@0
inputs:
image: 'localbuild/imagename:tag'
dockerfile: 'Dockerfile'
failBuild: true
customPolicyPath: '.anchore/policy.json'
| Input Name | Description | Required | Default Value |
|---|---|---|---|
| image | The image to scan | ✔️ | N/A |
| dockerfile | Path to the dockerfile used to build image. Adds metadata for the policy evaluation |
||
| failBuild | Fail the build if policy evaluation returns a fail. | false | |
| customPolicyPath | Path to a local policy bundle. | ||
| debug | More verbose logging output from the scanner. | false | |
| timeout | Set the scan timeout. | ||
| includeAppPackages | Include application packages for vulnerability matches. Requires more vuln data and thus scan will be slower but better results. | false | |
| anchoreVersion | An optional parameter to specify a specific version of anchore to use for the scan. | v0.8.1 | |
| printVulnerabilityReport | Print the vulnerability report to the screen. | true |
| Output Name | Description | Type |
|---|---|---|
| billOfMaterials | Path to a json file with the list of packages found in the image | string |
| vulnerabilities | Path to a json file with list of vulnerabilities found in image | string |
| policyCheck | Policy evaluation status of the image, either 'pass' or 'fail' | string |
This example builds a local image and runs an Anchore scan on the image. It
provides a custom Anchore policy which it assumes is contained in the root of
the repository under the .anchore/ directory. It will also fail the build if
the Anchore policy scan returns a fail result.
trigger:
- dev
stages:
- stage: Staging
displayName: Build and push to staging registry
jobs:
- job: Staging
displayName: Staging
steps:
- script: |
docker build -t localbuild/testimage:ci -f Dockerfile .
- task: Anchore@0
inputs:
image: 'localbuild/testimage:ci'
customPolicyPath: '.anchore/policy.json'
dockerfile: Dockerfile
failBuild: true
- script: |
echo $(policyStatus)
echo $(billOfMaterials)
cat $(billOfMaterials)
echo $(vulnerabilities)
cat $(vulnerabilities)
We love contributions, feedback, and bug reports. For issues with the invocation of this action, file issues in this repository.
For contributing, see Contributing.
For documentation on Anchore itself, including policy language and capabilities see the Anchore Documentation
Connect with the anchore community directly on slack.