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 orchestratedScan pipeline example and a dataLoad 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​

note

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

  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.

      5. Under Optional Configuration, select the Privileged checkbox.

Configure the background step
note

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.

In the pipeline examples below, the Docker-in-Docker step has resource limits of 2048Mi and 1000m.

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.

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 self-signed certificates. For more information, go to Configure STO to Download Images from a Private Registry.

Security step settings for Anchore Enterprise scans in STO​

note

You need to use a Security step to set up an Anchore Enterprise integration. An Anchore Enterprise scanner template is under development and will be available soon.

/step-palette -->

To set up your Anchore Enterprise integration with a Security step, do the following:

  1. Create a CI Build or Security Tests stage
  2. Add a Security step.
  3. Add the following setting:value pairs to the Security step.

  • product_name : anchore

  • scan_type : containerImage

  • product_config_name = default

  • policy_type : orchestratedScan, dataLoad, or ingestionOnly.

  • When policy_type is set to orchestratedScan or dataLoad:

    • product_domain : The fully-qualified URL to the scanner API, for example https://anchore.company.io/api or http://192.0.2.1:8228
    • product_access_id : Username to log in to the scanner.
    • product_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.container-access-id")>. For more information, go to Add and Reference Text Secrets.

  • When policy_type is set to dataLoad:

    • product_image_name : The name of the image that you want to extract from Anchore.

  • When policy_type is set to orchestratedScan:

    • container_project — The image owner and project, for example harness/delegate

  • fail_on_severity

  • tool_args You can use this field to run the Anchore Enterprise CLI with specific command-line arguments. For example, specify tool_args : --force.

Container image settings (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 : The image owner and project, for example harness/delegate

Target and variant (required)​

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

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:

Target name, type, and branch

For more information, go to Targets, baselines, and variants in STO.

Ingestion file (required for ingestion workflows)​

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.

    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.

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

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. A Security 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 orchestrated 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.
Anchore Enterprise dataload ingestion pipeline example

pipeline:
  allowStageExecutions: false
  projectIdentifier: STO
  orgIdentifier: default
  tags: {}
  stages:
    - stage:
        name: build
        identifier: build
        type: SecurityTests
        spec:
          cloneCodebase: false
          infrastructure:
            type: KubernetesDirect
            spec:
              connectorRef: K8S_DELEGATE_CONNECTOR
              namespace: harness-delegate-ng
              automountServiceAccountToken: true
              nodeSelector: {}
              containerSecurityContext:
                privileged: true
              os: Linux
          sharedPaths:
            - /var/run
            - /shared/customer_artifacts
          execution:
            steps:
              - step:
                  type: Background
                  name: Background_1
                  identifier: Background_1
                  spec:
                    connectorRef: CONTAINER_IMAGE_REGISTRY_CONNECTOR
                    image: docker:dind
                    shell: Sh
                    privileged: true
                    entrypoint:
                      - dockerd
                    resources:
                      limits:
                        memory: 2048Mi
                        cpu: 1000m  
              - step:
                  type: Security
                  name: Security_1
                  identifier: Security_1
                  spec:
                    privileged: true
                    settings:
                      policy_type: orchestratedScan
                      scan_type: container
                      product_name: anchore
                      product_config_name: default
                      container_domain: docker.io
                      container_project: owasp/nettacker
                      container_tag: latest
                      product_domain: https://anchore.qa.harness.io/api
                      container_type: docker_v2
                      product_access_id: aubrey.klaft@harness.io
                      product_access_token: <+secrets.getValue("anchoretoken")>
                      LOG_LEVEL: debug
                    imagePullPolicy: Always
          caching:
            enabled: false
            paths: []
          slsa_provenance:
            enabled: false
        variables:
          - name: runner_tag
            type: String
            value: dev
  identifier: anchore_scan
  name: anchore scan



Anchore Enterprise dataLoad 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. A Security 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. Scans the extracted image.
    4. Deduplicates and normalizes the scan data and ingests it into STO.

Note that in this example, the resource limages for the Security step are increased to ensure that the container used to run the scan has enough memory and CPU.

Anchore Enterprise dataload ingestion pipeline example

pipeline:
  allowStageExecutions: false
  projectIdentifier: STO
  orgIdentifier: default
  identifier: anchore_dataload
  name: anchore dataload
  tags: {}
  stages:
    - stage:
        name: build
        identifier: build
        type: SecurityTests
        spec:
          cloneCodebase: false
          infrastructure:
            type: KubernetesDirect
            spec:
              connectorRef: K8S_DELEGATE_CONNECTOR
              namespace: harness-delegate-ng
              automountServiceAccountToken: true
              nodeSelector: {}
              containerSecurityContext:
                privileged: true
              os: Linux
          sharedPaths:
            - /var/run
            - /shared/customer_artifacts
          execution:
            steps:
              - step:
                  type: Background
                  name: Background_1
                  identifier: Background_1
                  spec:
                    connectorRef: CONTAINER_IMAGE_REGISTRY_CONNECTOR
                    image: docker:dind
                    shell: Sh
                    privileged: true
                    entrypoint:
                      - dockerd
                    resources:
                      limits:
                        memory: 2048Mi
                        cpu: 1000m  
              - step:
                  type: Security
                  name: Security_1
                  identifier: Security_1
                  spec:
                    privileged: true
                    settings:
                      policy_type: dataLoad
                      scan_type: container
                      product_name: anchore
                      product_config_name: default
                      product_domain: https://anchore.myorg.org/api
                      product_access_id: jane.smith@myorg.org
                      product_access_token: <+secrets.getValue("anchoretoken")>
                      product_image_name: owasp/nettacker:latest
                      target_name: owasp/nettacker
                      target_variant: latest
                      LOG_LEVEL: debug
                    imagePullPolicy: Always
                    resources:
                      limits:
                        memory: 4Gi
                        cpu: 1000m
          caching:
            enabled: false
            paths: []
          slsa_provenance:
            enabled: false
        variables:
          - name: runner_tag
            type: String
            value: dev