Custom Scan step for supported scanners

Set up scanners using key-value pairs.

The Custom Scan step enables you to configure supported scanners that don't yet have their own dedicated step in the Harness Step Library.

Important notes for Custom Scan steps

• To configure a Custom Scan step, you add a set of key-value pairs in the Settings field. The key and value strings you need to specify, such as product_name and orchestratedScan, are case-sensitive.

• You need to add a Docker-in-Docker background step if you're running an orchestratedScan or dataLoad scan in a Kubernetes or Docker build infrastructure.

• You need to run the Custom Scan step with root access if you need to run a Docker-in-Docker step, or if you need to add trusted certificates to your scan images at runtime.

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

  • What's supported in STO

  • Security Testing Orchestration FAQs

  • Optimize STO pipelines

Workflow descriptions

Orchestration/extraction workflows

Ingestion workflows

Custom Scan settings reference

To set up a scanner, you add key-value pairs under Settings. The following sections describe the different settings and requirements.

Scanner configuration in a Custom Scan step

- step: type: Security name: custom_scan_xray identifier: custom_scan_xray spec: privileged: true settings: policy_type: ingestionOnly scan_type: containerImage product_name: xray product_config_name: default target_name: YOUR_REPO/YOUR_IMAGE target_variant: YOUR_TAG ingestion_file: /shared/scan_results/xray2.json

Scanner settings

These settings are required for most scanners. For more information, go to the reference for the scanner integration you're setting up.

• Product name

• Scan type

• Policy type

• Product config name

Product name

The scanner name. This is required for all Custom Scan steps.

Key

product_name

Value

Go to the relevant step configuration.

Scan type

The target type to scan.

Key

scan_type

Value

Must be one of the following. For supported values, go to the relevant step configuration.

containerImage

repository

instance

configuration

Policy type

The scan mode to use.

Key

policy_type

Value

Must be one of the following. For supported values, go to the relevant step configuration.

orchestratedScan

ingestionOnly

dataLoad

Product config name

Required for most scanner integrations.

Key

product_config_name

Value

For supported values, go to the relevant step configuration.

Target and variant

Code repositories

Container image

Application instances

Configurations

Ingestion file

Fail on Severity

Additional Configuration

Advanced settings