Skip to main content

Fortify on Demand scanner reference for STO



You can scan your repositories and ingest scan results from Fortify on Demand.

Workflow descriptions​

Orchestration/extraction workflows

This workflow applies to scanner integrations that support orchestratedScan or dataLoad scan modes.

  1. Add a Build or Security stage to your pipeline.

  2. If you're scanning a code repository, set up your codebase.

  3. Add a Custom Scan step.

  4. Review the Important notes for Custom Scan steps for additional requirements and relevant information.

    If you're setting up a scan on a Kubernetes or Docker build infrastructure, you need to add a Docker-in-Docker background step to the stage.

  5. Add the relevant key:value pairs to Settings.

Ingestion workflows

This workflow applies to scanner integrations that support Ingestion mode.

  1. Add a Build or Security stage to your pipeline.

  2. Add a Run step and set it up to save your scan results to a shared folder.

    For more information, go to Run an ingestion scan in an STO Pipeline.

  3. Add a Custom Scan step.

  4. Review the Important notes for Custom Scan steps for additional requirements and relevant information.

  5. Add the relevant key:value pairs to Settings.

Custom Scan step settings for Fortify on Demand​

Scanner settings​

These settings are required.

Product name​

The scanner name.

Key​
product_name
Value​
fortifyondemand

Scan type​

The target type to scan.

Key​
scan_type
Value​
repository

Policy type​

The scan mode to use.

Key​
policy_type
Value​
orchestratedScan
ingestionOnly
dataLoad

Product config name​

Key​
product_config_name
Value​

If product_lookup_type = Static:

sast

If product_lookup_type = Dynamic:

dast

Target and variant​

Every Custom Scan step needs a target and baseline.

Target name​

Key​
target_name
Value​

A user-defined label for the code repository, container, application, or configuration to scan. Specify a unique, descriptive name. This makes it much easier to navigate your scan results in the STO UI.

Target variant​

Key​
target_variant
Value​

A user-defined label for the branch, tag, or other target variant to scan.

Product access​

These settings are available to access your Fortify on Demand SaaS instance when policy_type is orchestratedScan or dataLoad.

You should create Harness text secrets for your encrypted passwords and tokens and reference them using the format <+secrets.getValue("my-access-token")>.

Product access keys​

product_domain
product_access_id
product_access_token
product_owner_id
product_entitlement
product_scan_type
product_app_name
product_release_name
product_target_language
product_target_language_version
product_audit_type
product_data_center

Product scan settings​

Key​
product_scan_settings
Values​
Custom
default

Product lookup type​

Key​
product_lookup_type
Values​
Dynamic
Static
Mobile

Ingestion file​

This setting applies to Custom Scan steps when the policy_type is ingestionOnly.

Key​
ingestion_file
Value​

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 scan results 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

Fail on Severity​

If the scan finds any vulnerability with the specified severity level or higher, the pipeline fails automatically. NONE means do not fail on severity.

For more information, go to Stop builds based on scan results.

Key​
fail_on_severity
Value​
CRITICAL
MEDIUM
LOW
INFO
NONE