Skip to main content

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

To scan a container image, you must have Docker-in-Docker running as a background service in the stage where you're running the scan.

Set up a Docker-in-Docker background step

In the Execution tab, do the following:

  1. Click Add Step and then choose Background.
  2. Configure the Background step as follows:
  3. Dependency Name = dind
  4. Container Registry = The Docker connector to download the DinD image. If you don't have one defined, go to Docker connector settings reference.
  5. Image = docker:dind
  6. Under Optional Configuration, select the Privileged checkbox.
Configure the background step

Security step settings

Security step dialog box

Here's an example of how to set up a scan in a Security step. scan_type and policy_type are scanner-specific; the other settings are common to scans of container images.

A screenshot of the Harness Platform that highlights the Create Project button in the Feature Flag module.
  • 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 secret
  • configuration_access_token = Your AWS Access Token secret
  • configuration_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.
Container image scan settings

The following settings apply to all scanners where the scan_type is containerImage.

  • container_project (required)
  • container_tag (required)
  • container_type
    • accepted value(s): local_image, docker_v2, jfrog_artifactory, aws_ecr
      • for container_type set to local
        • None
      • for container_type set to docker_v2
        • container_access_id: Username
        • container_access_token: Password/Token
      • for container_type set to jfrog_artifactory
        • container_access_id: Username
        • container_access_token: Password/Token
      • for container_type set to aws_ecr
        • container_access_id: Username
        • container_access_token: Password/Token
        • container_region: AWS default region
  • container_domain
Target NameTarget Type
local_imagecontainer
docker_v2container
jfrog_artifactorycontainer
aws_ecrcontainer
websiteinstance
Ingestion scan settings

The following settings are required for Security steps where the policy_type is ingestionOnly.

  • target name The Identifier that you want to assign to the target you’re scanning in the pipeline. Use a unique, descriptive name such as codebaseAlpha or jsmith/myalphaservice.

  • variant An identifier for a specific target to scan, such as the branch name or image tag. This identifier is used to differentiate or group results for a target. Harness maintains a historical trend for each variant.

  • 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. STO steps can ingest scan data in SARIF and Harness Custom JSON format.

The following steps outline the general workflow for ingesting scan data into your pipeline:

  1. 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.

  2. 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.

  3. Add a Security step after the Run step and add the target name, variant, and ingestion_file settings as described above.

For a complete workflow description and example, go to Ingest Scan Results into an STO Pipeline.

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