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
If you want to add trusted certificates to your scan images at runtime, you need to run the scan step with root access.
You can set up your STO scan images and pipelines to run scans as non-root and establish trust for your own proxies using custom 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.
- Extraction Configure the step to extract scan results from an external SaaS service and then ingest, normalize, and deduplicate the data.
- Ingestion Configure the step to read scan results from a data file and then ingest, normalize, and deduplicate the data.
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 theCrawl 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.
Target and variant detection
When auto-detect is enabled for application instances, the step detects these values as follows:
- The target is based on the Instance Domain and Path defined in the step or runtime input, for example
https://qa.jpgr.org:3002/login/us
. - The variant is the UTC timestamp when the step scanned the instance.
Note the following:
-
Auto-detection is not available when the Scan Mode is Ingestion.
-
Auto-detect 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.
-
You should carefully consider the baseline you want to specify for your instance target. Every target needs a baseline to enable the full suite of STO features. Here are a few options:
-
Specify a RegEx baseline that captures timestamps. This ensures that every new scan compares issues in the new scan vs. the previous scan. Then it updates the baseline to the current scan.
You can use this RegEx to capture timestamps:
\d{2}/\d{2}/\d{4}\,\s\d{2}\:\d{2}\:\d{2}
-
Specify a fixed baseline.
- Scan the instance using a manual variant name.
- Select the baseline as a fixed value.
- Update the step to use auto-detect for future scans.
This ensures that future scans get compared with one fixed baseline.
-
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