Amazon Image scanner reference
You can set up an Amazon Image scanner using a Security step: create a CI Build or Security Tests stage, add a Security step, and then add the setting:value
pairs as specified below.
Before you begin
Docker-in-Docker requirements
Docker-in-Docker is not required for ingestion workflows where the scan data has already been generated.
You need to include a Docker-in-Docker background service in your stage if either of these conditions apply:
- You configured your scanner using a generic Security step rather than a scanner-specific template such as Aqua Trivy, Bandit, Mend, Snyk, etc.
- You’re scanning a container image using an Orchestration or Extraction workflow.
Set up a Docker-in-Docker background step
Go to the stage where you want to run the scan.
In Overview, add the shared path
/var/run
.In Execution, do the following:
- Click Add Step and then choose Background.
- Configure the Background step as follows:
- Dependency Name =
dind
- Container Registry = The Docker connector to download the DinD image. If you don't have one defined, go to Docker connector settings reference.
- Image =
docker:dind
- Under Optional Configuration, select the Privileged checkbox.
- Dependency Name =
Root access requirements
You need to run the scan step with root access if either of the following apply:
You need to run a Docker-in-Docker background service. This is required in the following scenarios only:
You're using a generic Security step to run an Orchestrated or Extraction scan, rather than a scanner-specific step such as Aqua Trivy, Bandit, etc. (not required for Ingestion scans).
You're scanning a container image using an Orchestrated or Extraction scan (not required for Ingestion scans).
You need to add trusted certificates to your scan images at runtime.
You can set up your STO scan images and pipelines to run scans as non-root and establish trust for your own proxies using self-signed certificates. For more information, go to Configure STO to Download Images from a Private Registry.
Security step settings
product_name
=aws-ecr
scan_type
=containerImage
policy_type
=dataLoad
,ingestionOnly
product_config_name
=default
container_project
= The name of the scanned ECR container with the results you want to ingest.container_tag
= The container tag for the given container project.configuration_access_id
= Your AWS Access ID secretconfiguration_access_token
= Your AWS Access Token secretconfiguration_region
= The AWS region where the container is located. For example,us-east-1
container_domain
= URI of the ECR container with the scan results you want to load.fail_on_severity
- See Fail on Severity.
Target and variant
The following settings are required for every Security step:
target_name
A user-defined label for the code repository, container, application, or configuration to scan.variant
A user-defined label for the branch, tag, or other target variant to scan.
Make sure that you give unique, descriptive names for the target and variant. This makes navigating your scan results in the STO UI much easier.
You can see the target name, type, and variant in the Test Targets UI:
For more information, go to Targets, baselines, and variants in STO.
Container settings
The following settings apply to all scanners where the scan_type
is containerImage
.
container_type
- accepted value(s):
local_image
,docker_v2
,jfrog_artifactory
,aws_ecr
- for
container_type
set tolocal
None
- for
container_type
set todocker_v2
container_access_id
: Usernamecontainer_access_token
: Password/Token
- for
container_type
set tojfrog_artifactory
container_access_id
: Usernamecontainer_access_token
: Password/Token
- for
container_type
set toaws_ecr
container_access_id
: Usernamecontainer_access_token
: Password/Tokencontainer_region
: AWS default region
- for
- accepted value(s):
container_domain
Ingestion file
The following setting is required for Security steps where the policy_type
is ingestionOnly
.
ingestion_file
The results data file to use when running an Ingestion scan. You should specify the full path to the data file in your workspace, such as/shared/customer_artifacts/my_scan_results.json
.In addition to ingesting scan data in the external scanner's native format, STO steps can also ingest data in SARIF and Harness Custom JSON format.
The following steps outline the general workflow for ingesting scan data into your pipeline. For a complete workflow description and example, go to Ingest Scan Results into an STO Pipeline.
Specify a shared folder for your scan results, such as
/shared/customer_artifacts
. You can do this in the Overview tab of the Security stage where you're ingesting your data.Create a Run step that copies your scan results to the shared folder. You can run your scan externally, before you run the build, or set up the Run step to run the scan and then copy the results.
Add a Security step after the Run step and add the
target name
,variant
, andingestion_file
settings as described above.
Fail on Severity
Every Security step has a Fail on Severity setting. If the scan finds any vulnerability with the specified severity level or higher, the pipeline fails automatically. You can specify one of the following:
CRITICAL
HIGH
MEDIUM
LOW
INFO
NONE
— Do not fail on severity
The YAML definition looks like this: fail_on_severity : critical # | high | medium | low | info | none