Skip to main content

Anchore Enterprise scanner reference for STO

You can scan your repositories and other components used in your code with Anchore Enterprise, a scanner that provides visibility into supply chain security risks.

Important notes for running Anchore Enterprise scans in STO​

All data ingestion methods are supported​

You can run Orchestration, Extraction, and Ingestion workflows with Anchore Enterprise. This topic includes an Orchestration pipeline example below.

Scans in air-gapped environments are supported​

You can run Anchore Enterprise scans in air-gapped environments. For more information, go to the Anchore Enterprise documentation:

Docker-in-Docker requirements​

The following use cases require a Docker-in-Docker background step in your pipeline:

  • Container image scans on Kubernetes and Docker build infrastructures
  • Security steps (not step palettes) on Kubernetes and Docker build infrastructures
    • Required for all target types and Orchestration/DataLoad modes

The following use cases do not require Docker-in-Docker:

Set up a Docker-in-Docker background step

  1. Go to the stage where you want to run the scan.

  2. In Overview, add the shared path /var/run.

  3. In Execution, do the following:

    1. Click Add Step and then choose Background.

    2. Configure the Background step as follows:

      1. Dependency Name = dind

      2. Container Registry = The Docker connector to download the DinD image. If you don't have one defined, go to Docker connector settings reference.

      3. Image = docker:dind

      4. Under Entry Point, add the following: dockerd

        In most cases, using dockerd is a faster and more secure way to set up the background step. For more information, go to the TLS section in the Docker quick reference.

      If the DinD service doesn't start with dockerd, clear the Entry Point field and then run the pipeline again. This starts the service with the default entry point.

      1. Under Optional Configuration, select the Privileged checkbox.
Configure the background step
note

For Orchestrated and Extraction scans, you might want to increase the resource limits for your Docker-in-Docker background step. This can speed up your scan times, especially for large scans. For more information, go to Optimize STO pipelines.

Root access requirements​

You need to run the scan step with root access if either of the following apply:

note

You can set up your STO scan images and pipelines to run scans as non-root and establish trust for your own proxies using custom certificates. For more information, go to Configure STO to Download Images from a Private Registry.

For more information​

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

Anchore Enterprise step settings in STO​

The recommended workflow is add an Anchore Enterprise step to a Security Tests or CI Build stage and then configure it as described below.

Scan​

Scan mode​

  • Orchestration Configure the step to run a scan and then ingest, normalize, and deduplicate the results.

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 auto-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:

  • Auto-detection is not available when the Scan Mode is Ingestion.
  • Auto-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.

Container Image​

Type (orchestration)​

The registry type where the image is stored:

Domain​

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

Access ID​

The username to log in to the image registry.

Access Token​

The access token used to log in to the image registry. In most cases this is 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.container-access-id")>. For more information, go to Add and Reference Text Secrets.

Ingestion File​

The path to your scan results when running an Ingestion scan, for example /shared/scan_results/myscan.latest.sarif.

  • The data file must be in a supported format for the scanner.

  • The data file must be accessible to the scan step. It's good practice to save your results files to a shared path in your stage. In the visual editor, go to the stage where you're running the scan. Then go to Overview > Shared Paths. You can also add the path to the YAML stage definition like this:

        - stage:
          spec:
            sharedPaths:
              - /shared/scan_results

Authentication​

Domain​

The fully-qualified URL to the scanner API, for example https://anchore.company.io/api or http://192.0.2.1:8228.

Access ID​

The username to log in to the scanner.

Access Token​

The access token to log in to the scanner. In most cases this is 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.

Scan Tool​

Image Name​

For Extraction scans, the name of the image that you want to extract from Anchore.

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

Additional CLI flags​

Use this field to run the Anchore Enterprise CLI with flags such as --force. This flag resets the image analysis status to not_analyzed.

caution

Passing additional CLI flags is an advanced feature. Harness recommends the following best practices:

  • Test your flags and arguments thoroughly before you use them in your Harness pipelines. Some flags might not work in the context of STO.

  • Don't add flags that are already used in the default configuration of the scan step.

    To check the default configuration, go to a pipeline execution where the scan step ran with no additional flags. Check the log output for the scan step. You should see a line like this:

    Command [ scancmd -f json -o /tmp/output.json ]

    In this case, don't add -f or -o to Additional CLI flags.

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

Settings​

You can use this field to specify environment variables for your scanner.

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:

Anchore Enterprise orchestration example​

This example uses a Security step in Orchestration mode to scan a repository. The pipeline has one SecurityTests stage with two steps:

  1. A Background step that runs Docker-in-Docker. This is required to scan container images.

  2. An Anchore step that does the following:

    1. Extracts the owasp/nettacker:latest image from Anchore Enterprise.
    2. Logs in to the Anchore Enterprise API based on the product_domain, product_access_id, product_access_token settings.
    3. Launches an orchestration scan of the owasp/nettacker project in Anchore Enterprise and gets the scan results from the Anchore server.
    4. Deduplicates and normalizes the scan data and ingests it into STO.

Note that in this example, the resource limits for the Docker-in-Docker step are increased to ensure that the step has enough memory to store the scanned image.

Anchore Enterprise orchestration pipeline example

pipeline:
  name: anchore step palette
  identifier: anchore_step_palette
  projectIdentifier: default
  orgIdentifier: default
  tags: {}
  stages:
    - stage:
        name: anchore
        identifier: anchore
        type: SecurityTests
        spec:
          cloneCodebase: false
          execution:
            steps:
              - step:
                  type: Background
                  name: docker_dind
                  identifier: docker_dind
                  spec:
                    connectorRef: YOUR_DOCKER_CONNECTOR_ID
                    image: docker:dind
                    shell: Sh
                    command: dockerd
                    privileged: true
                    resources:
                      limits:
                        memory: 2048Mi
                        cpu: 1000m
              - step:
                  type: Anchore
                  name: Anchore_1
                  identifier: Anchore_1
                  spec:
                    mode: orchestration
                    config: default
                    target:
                      name: owasp/nettacker
                      type: container
                      variant: latest
                    advanced:
                      log:
                        level: info
                      args:
                        cli: "--force"
                    privileged: true
                    image:
                      type: docker_v2
                      name: owasp/nettacker
                      tag: latest
                    auth:
                      access_token: <+secrets.getValue("YOUR_ACCESS_TOKEN_SECRET")>
                      access_id: <+secrets.getValue("YOUR_ACCESS_ID_SECRET")>
                      domain: YOUR_DOMAIN_URL
          infrastructure:
            type: KubernetesDirect
            spec:
              connectorRef: YOUR_KUBERNETES_CLUSTER_CONNECTOR_ID
              namespace: YOUR_KUBERNETES_NAMESPACE
              automountServiceAccountToken: true
              nodeSelector: {}
              os: Linux
          sharedPaths:
            - /var/run
          caching:
            enabled: false
            paths: []
          slsa_provenance:
            enabled: false