Skip to main content

Burp scanner reference

You can set up any supported scanner using a Security step: create a CI Build or Security Tests stage, add a Security step, and then add the setting:value pairs as specified below.

Security step settings​

Burp scan configuration in Security Scan step

  • 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_identifier (required)
  • instance_environment (required)
  • 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.
Orchestrated 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 Orchestrated 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 scan settings

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

  • target name The Identifier that you want to assign to the target you’re scanning in the pipeline. Use a unique, descriptive name such as codebaseAlpha or jsmith/myalphaservice.

  • variant An identifier for a specific target to scan, such as the branch name or image tag. This identifier is used to differentiate or group results for a target. Harness maintains a historical trend for each variant.

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

The following steps outline the general workflow for ingesting scan data into your 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.

For a complete workflow description and example, go to Ingest Scan Results into an STO Pipeline.

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