Skip to main content

Burp scanner reference for STO

You can scan your application instances using Burp Enterprise.

Important notes for running Burp scans in STO​

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 self-signed 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:

Burp step settings for STO scans​

The recommended workflow is add a Burp 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.

The following configurations are available for Orchestration scans. These are built-in configurations provided by Burp Enterprise.

  • Default This is the same as the Crawl and Audit - Lightweight built-in configuration.
  • Never stop Crawl due to application errors
  • Never stop audit due to application errors
  • Minimize false positives
  • Minimize false negatives
  • Crawl strategy most complete
  • Crawl strategy more complete
  • Crawl strategy fastest
  • Crawl strategy faster
  • Crawl limit 60 minutes
  • Crawl limit 30 minutes
  • Crawl limit 10 minutes
  • Crawl and audit lightweight
  • Crawl and audit fast
  • Crawl and audit deep
  • Crawl and audit balanced
  • Audit coverage thorough
  • Audit coverage maximum
  • Audit checks medium active
  • Audit checks light active
  • Audit checks critical issues only
  • Audit checks all except time based detection methods
  • Audit checks all except java script analysis

Target​

Type​
  • Instance Scan a running application.

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.

Authentication​

Domain​

Domain of the application instance to scan. Example: https://myapp.io/portal/us

Access Token​

The access token used to log in to a specific product in the scanner. This is required for some scans. 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.

Scan Tool​

Use this setting to specify a specific scan to ingest. If this is not specified, the pipeline ingests the most recent scan.

Instance​

Domain​

Domain of the application instance to scan. You can include the full path to the app in this field, or split the full path between the Domain and the Path fields. Example: https://myapp.io/portal/us

Protocol​

HTTPS (default) or HTTP.

Port​

The TCP port used by the scanned app instance.

Path​

Path to append to the application instance domain, if you're splitting the full path between the Domain and Path settings. For example, you might specify the domain as https://myapp.io and the path as /portal/us.

Username​

Username to log in to the instance you want to scan.

Password​

The access token to log in to the instance you want to scan. 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

Security step settings for Burp scans in STO (legacy)​

note

You can set up Burp scans using a Security step, but this is a legacy functionality. Harness recommends that you use a Burp step instead.

Target and variant​

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.

Burp scan settings​

  • product_name = burp
  • scan_type = instance
  • policy_type = orchestratedScan, dataLoad, or ingestionOnly
  • product_config_name
    • The following configurations are available. These are built-in configurations provided by Burp Enterprise.
      • default This is the same as the Crawl and Audit - Lightweight built-in configuration.
      • never-stop-crawl-due-to-application-errors
      • never-stop-audit-due-to-application-errors
      • minimize-false-positives
      • minimize-false-negatives
      • crawl-strategy-most-complete
      • crawl-strategy-more-complete
      • crawl-strategy-fastest
      • crawl-strategy-faster
      • crawl-limit-60-minutes
      • crawl-limit-30-minutes
      • crawl-limit-10-minutes
      • crawl-and-audit-lightweight
      • crawl-and-audit-fast
      • crawl-and-audit-deep
      • crawl-and-audit-balanced
      • audit-coverage-thorough
      • audit-coverage-maximum
      • audit-checks-medium-active
      • audit-checks-light-active
      • audit-checks-critical-issues-only
      • audit-checks-all-except-time-based-detection-methods
      • audit-checks-all-except-java-script-analysis
  • fail_on_severity - See Fail on Severity.

Instance scan settings​

The following settings apply to Security steps where the scan_type is instance.

  • instance_domain
  • instance_path
  • instance_protocol
  • instance_port
  • instance_username The username for authenticating with the external scanner.
  • instance_password You should create a Harness text secret with your encrypted password and reference the secret using the format <+secrets.getValue("project.container-access-id")>. For more information, go to Add and reference text secrets.

Orchestration scan settings​

The following settings are required for Security steps where the policy_type is orchestratedScan.

  • product_domain Domain of the application instance to scan. You can include the full path to the app in this field, or split the full path between the Domain and the Path fields. Example: https://myapp.io/portal/us

  • product_access_token The access token used to log in to a specific product in the scanner. This is required for some scans. 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.

For a complete workflow description and example, go to Run an Orchestration Scan in an STO Pipeline.

Dataload scan settings​

The following settings are required for Security steps where the policy_type is dataLoad.

  • product_site_id The Burp enterprise site identifier.

  • product_domain Domain of the application instance to scan. Example: https://myapp.io/portal/us

    You need to specify either the product_site_id or the product_domain.

  • product_scan_id Use this setting to specify a specific scan to ingest. If this is not specified, the pipeline will ingest the most recent scan.

  • product_access_token The access token used to log in to a specific product in the scanner. This is required for some scans. 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​

If the policy_type is ingestionOnly:

  • 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

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