Skip to main content

Black Duck step configuration



You can scan your repositories and container images using Black Duck Hub and ingest the results into Harness STO.

Important notes for running Black Duck Hub scans in STO​

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

Black Duck Hub step settings for STO scans​

The recommended workflow is to add a BlackDuck step to a Security or 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​

  • Repository Scan a codebase repo.

    In most cases, you specify the codebase using a code repo connector that connects to the Git account or repository where your code is stored. For information, go to Configure codebase.

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

Target and Variant Detection​

When Auto is enabled for code repositories, the step detects these values using git:

  • To detect the target, the step runs git config --get remote.origin.url.
  • To detect the variant, the step runs git rev-parse --abbrev-ref HEAD. The default assumption is that the HEAD branch is the one you want to scan.

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

Workspace​

The workspace path on the pod running the scan step. The workspace path is /harness by default.

You can override this if you want to scan only a subset of the workspace. For example, suppose the pipeline publishes artifacts to a subfolder /tmp/artifacts and you want to scan these artifacts only. In this case, you can specify the workspace path as /harness/tmp/artifacts.

Additionally, you can specify individual files to scan as well. For instance, if you only want to scan a specific file like /tmp/iac/infra.tf, you can specify the workspace path as /harness/tmp/iac/infra.tf

Container image​

Type​

The registry type where the image is stored:

  • Docker v2 A registry that uses the Docker Registry v2 API such as Docker Hub, Google Container Registry, or Google Artifact Registry.

  • AWS ECR

  • Jfrog Artifactory

  • Local Image in this Stage Scan a local image built and stored within the context of the current stage (via /var/run/docker.sock registered as a stage level volume mount).

  • Local OCI/Docker archive in this Stage Scan an OCI or Docker archive that has been created and stored within the current stage. The path to the archive can be specified via the workspace field, and ensure that the path to which the archive is saved is a shared volume mount.

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

Ingestion​

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.

Enforce SSL​

The step and the scanner communicate over SSL by default. Set this to false to disable SSL (not safe).

API Version​

The scanner API version. Some scanners require this.

Type​

The authentication method for the external scanner:

  • Username & Password
  • API Key

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("my-access-token")>. For more information, go to Add and Reference Text Secrets.

Scan Tool​

Project Name​

The name of the scan project as defined in the scanner. This is the also the target name in the Harness UI (Security Tests > Test Targets).

Project Version​

The version of the scan project, as defined in the scanner.

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 synopsis detect scanner with flags such as:

-detect.tools.excluded {DETECTOR, SIGNATURE}

This string excludes some detectors from a scan.

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 STO 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

Settings​

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

Additional Configuration​

The fields under Additional Configuration vary based on the type of infrastructure. Depending on the infrastructure type selected, some fields may or may not appear in your settings. Below are the details for each field

Advanced settings​

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

Proxy settings​

This step supports Harness Secure Connect if you're using Harness Cloud infrastructure. During the Secure Connect setup, the HTTPS_PROXY and HTTP_PROXY variables are automatically configured to route traffic through the secure tunnel. If there are specific addresses that you want to bypass the Secure Connect proxy, you can define those in the NO_PROXY variable. This can be configured in the Settings of your step.

If you need to configure a different proxy (not using Secure Connect), you can manually set the HTTPS_PROXY, HTTP_PROXY, and NO_PROXY variables in the Settings of your step.

Definitions of Proxy variables:​

  • HTTPS_PROXY: Specify the proxy server for HTTPS requests, example https://sc.internal.harness.io:30000
  • HTTP_PROXY: Specify the proxy server for HTTP requests, example http://sc.internal.harness.io:30000
  • NO_PROXY: Specify the domains as comma-separated values that should bypass the proxy. This allows you to exclude certain traffic from being routed through the proxy.

Troubleshooting Black Duck Hub​

Scan fails with message "Could not connect to addon client after max retries"​

This message indicates that indicates that the container running the BlackDuck scan step is terminated abruptly due to insufficient resources. Harness recommends that you increase the resource allocation using an iterative approach: Run the scan again with memory: 1Gi and cpu: "1.0", monitor the results, and adjust the resource allocation until the scanner runs successfully.

For more information, go to Optimize STO pipelines.