Skip to main content

AWS ECR scanner reference for STO



You can scan your container images and extract scan results from Amazon Elastic Container Registry (ECR).

Important notes for running AWS ECR scans in STO

The following topics contain useful information for setting up scanner integrations in STO:

AWS ECR step settings for STO scans

The recommended workflow is to add an AWS ECR step to a Security or Build stage and then configure it as described below.

Scan

Scan Mode

Scan Configuration

The predefined configuration to use for the scan. All scan steps have at least one configuration.

Target

Type

  • Container Image Scan the layers, libraries, and packages in a container image.

Detect target and variant

When Detect is enabled for container images, the step detects the target and variant using the Container Image Name and Tag defined in the step or runtime input.

Note the following:

  • Detect is not available when the Scan Mode is Ingestion.
  • Detect is the default selection for new pipelines. Manual is the default for old pipelines, but you might find that neither radio button is selected in the UI.

Name

The identifier for the target, such as codebaseAlpha or jsmith/myalphaservice. Descriptive target names make it much easier to navigate your scan data in the STO UI.

It is good practice to specify a baseline for every target.

Variant

The identifier for the specific variant to scan. This is usually the branch name, image tag, or product version. Harness maintains a historical trend for each variant.

Artifacts

Type (orchestration)

The registry type where the image is stored:

Domain (extraction)

The URL of the registry that contains the image to scan. Examples include:

  • docker.io
  • app.harness.io/registry
  • us-east1-docker.pkg.dev
  • us.gcr.io

Name

The image name. For non-local images, you also need to specify the image repository. Example: jsmith/myalphaservice

Tag

The image tag. Examples: latest, 1.2.3

Region

The region where the image to scan is located, as defined by the cloud provider such as AWS.

Authentication

Access ID (orchestration)

The username to log in to the scanner.

Access Token

The access token to log in to the scanner. This is usually a password or an API key.

You should create a Harness text secret with your encrypted token and reference the secret using the format <+secrets.getValue("project.my-access-token")>. For more information, go to Add and Reference Text Secrets.

Session Token

If you need to specify a session token, add it using the key AWS_SESSION_TOKEN under Settings.

Access Region

The AWS region of the image to scan.

Log Level

The minimum severity of the messages you want to include in your scan logs. You can specify one of the following:

  • DEBUG
  • INFO
  • WARNING
  • ERROR

Fail on Severity

Every Custom Scan 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

Additional Configuration

In the Additional Configuration settings, you can use the following options:

Advanced settings

In the Advanced settings, you can use the following options: