DAST proxy-based analyzer (ULTIMATE)
The DAST proxy-based analyzer can be added to your GitLab CI/CD pipeline. This helps you discover vulnerabilities in web applications that do not use JavaScript heavily. For applications that do, please see the DAST browser-based analyzer.
WARNING: Do not run DAST scans against a production server. Not only can it perform any function that a user can, such as clicking buttons or submitting forms, but it may also trigger bugs, leading to modification or loss of production data. Only run DAST scans against a test server.
The analyzer uses the OWASP Zed Attack Proxy (ZAP) to scan in two different ways:
- Passive scan only (default). DAST executes ZAP's Baseline Scan and doesn't actively attack your application.
- Passive and active (or full) scan. DAST can be configured to also perform an active scan to attack your application and produce a more extensive security report. It can be very useful when combined with Review Apps.
Templates
- The DAST latest template was introduced in GitLab 13.8.
- All DAST templates were updated to DAST_VERSION: 2 in GitLab 14.0.
- All DAST templates were updated to DAST_VERSION: 3 in GitLab 15.0.
GitLab DAST configuration is defined in CI/CD templates. Updates to the template are provided with GitLab upgrades, allowing you to benefit from any improvements and additions.
Available templates:
-
DAST.gitlab-ci.yml
: Stable version of the DAST CI/CD template. -
DAST.latest.gitlab-ci.yml
: Latest version of the DAST template.
WARNING: The latest version of the template may include breaking changes. Use the stable template unless you need a feature provided only in the latest template.
For more information about template versioning, see the CI/CD documentation.
DAST versions
By default, the DAST template uses the latest major version of the DAST Docker image. You can choose
how DAST updates, using the DAST_VERSION
variable:
- Automatically update DAST with new features and fixes by pinning to a major
version (such as
1
). - Only update fixes by pinning to a minor version (such as
1.6
). - Prevent all updates by pinning to a specific version (such as
1.6.4
).
Find the latest DAST versions on the DAST releases page.
DAST run options
You can use DAST to examine your web application:
- Automatically, initiated by a merge request.
- Manually, initiated on demand.
Some of the differences between these run options:
Automatic scan | On-demand scan |
---|---|
DAST scan is initiated by a merge request. | DAST scan is initiated manually, outside the DevOps life cycle. |
CI/CD variables are sourced from .gitlab-ci.yml . |
CI/CD variables are provided in the UI. |
All DAST CI/CD variables available. | Subset of DAST CI/CD variables available. |
DAST.gitlab-ci.yml template. |
DAST-On-Demand-Scan.gitlab-ci.yml template. |
Enable automatic DAST run
To enable DAST to run automatically, either:
- Enable Auto DAST (provided by Auto DevOps).
-
Edit the
.gitlab.ci.yml
file manually. - Use an automatically configured merge request.
.gitlab.ci.yml
file manually
Edit the In this method you manually edit the existing .gitlab-ci.yml
file. Use this method if your GitLab CI/CD configuration file is complex.
To include the DAST template:
-
On the top bar, select Main menu > Projects and find your project.
-
On the left sidebar, select CI/CD > Editor.
-
Copy and paste the following to the bottom of the
.gitlab-ci.yml
file.To use the DAST stable template:
include: - template: DAST.gitlab-ci.yml
To use the DAST latest template:
include: - template: DAST.latest.gitlab-ci.yml
-
Define the URL to be scanned by DAST by using one of these methods:
-
Set the
DAST_WEBSITE
CI/CD variable. If set, this value takes precedence. -
Add the URL in an
environment_url.txt
file at the root of your project. This is useful for testing in dynamic environments. To run DAST against an application dynamically created during a GitLab CI/CD pipeline, a job that runs prior to the DAST scan must persist the application's domain in anenvironment_url.txt
file. DAST automatically parses theenvironment_url.txt
file to find its scan target.For example, in a job that runs prior to DAST, you could include code that looks similar to:
script: - echo http://${CI_PROJECT_ID}-${CI_ENVIRONMENT_SLUG}.domain.com > environment_url.txt artifacts: paths: [environment_url.txt] when: always
You can see an example of this in our Auto DevOps CI YAML file.
-
-
Select the Validate tab, then select Validate pipeline. The message Simulation completed successfully indicates the file is valid.
-
Select the Edit tab.
-
Optional. In Commit message, customize the commit message.
-
Select Commit changes.
Pipelines now include a DAST job.
The results are saved as a DAST report artifact that you can later download and analyze. Due to implementation limitations, we always take the latest DAST artifact available. Behind the scenes, the GitLab DAST Docker image is used to run the tests on the specified URL and scan it for possible vulnerabilities.
Configure DAST using the UI
In this method you select options in the UI. Based on your selections, a code
snippet is created that you paste into the .gitlab-ci.yml
file.
To configure DAST using the UI:
- On the top bar, select Main menu > Projects and find your project.
- On the left sidebar, select Security & Compliance > Configuration.
- In the Dynamic Application Security Testing (DAST) section, select Enable DAST or Configure DAST.
- Select the desired Scanner profile, or select Create scanner profile and save a scanner profile. For more details, see scanner profiles.
- Select the desired Site profile, or select Create site profile and save a site profile. For more details, see site profiles.
- Select Generate code snippet. A modal opens with the YAML snippet corresponding to the options you selected.
- Do one of the following:
- To copy the snippet to your clipboard, select Copy code only.
- To add the snippet to your project's
.gitlab-ci.yml
file, select Copy code and open.gitlab-ci.yml
file. The Pipeline Editor opens.- Paste the snippet into the
.gitlab-ci.yml
file. - Select the Validate tab, then select Validate pipeline. The message Simulation completed successfully indicates the file is valid.
- Select the Edit tab.
- Optional. In Commit message, customize the commit message.
- Select Commit changes.
- Paste the snippet into the
Pipelines now include a DAST job.
API scan
- The DAST API analyzer is used for scanning web APIs. Web API technologies such as GraphQL, REST, and SOAP are supported.
URL scan
- Introduced in GitLab 13.4.
- Improved in GitLab 13.11.
A URL scan allows you to specify which parts of a website are scanned by DAST.
Define the URLs to scan
URLs to scan can be specified by either of the following methods:
- Use
DAST_PATHS_FILE
CI/CD variable to specify the name of a file containing the paths. - Use
DAST_PATHS
variable to list the paths.
DAST_PATHS_FILE
CI/CD variable
Use Introduced in GitLab 13.6.
To define the URLs to scan in a file, create a plain text file with one path per line.
page1.html
/page2.html
category/shoes/page1.html
To scan the URLs in that file, set the CI/CD variable DAST_PATHS_FILE
to the path of that file.
The file can be checked into the project repository or generated as an artifact by a job that
runs before DAST.
By default, DAST scans do not clone the project repository. Instruct the DAST job to clone
the project by setting GIT_STRATEGY
to fetch. Give a file path relative to CI_PROJECT_DIR
to DAST_PATHS_FILE
.
include:
- template: DAST.gitlab-ci.yml
variables:
GIT_STRATEGY: fetch
DAST_PATHS_FILE: url_file.txt # url_file.txt lives in the root directory of the project
DAST_BROWSER_SCAN: "true" # use the browser-based GitLab DAST crawler
DAST_PATHS
CI/CD variable
Use Introduced in GitLab 13.4.
To specify the paths to scan in a CI/CD variable, add a comma-separated list of the paths to the DAST_PATHS
variable. Note that you can only scan paths of a single host.
include:
- template: DAST.gitlab-ci.yml
variables:
DAST_PATHS: "/page1.html,/category1/page1.html,/page3.html"
DAST_BROWSER_SCAN: "true" # use the browser-based GitLab DAST crawler
When using DAST_PATHS
and DAST_PATHS_FILE
, note the following:
-
DAST_WEBSITE
must be defined when using eitherDAST_PATHS_FILE
orDAST_PATHS
. The paths listed in either useDAST_WEBSITE
to build the URLs to scan - Spidering is disabled when
DAST_PATHS
orDAST_PATHS_FILE
are defined -
DAST_PATHS_FILE
andDAST_PATHS
cannot be used together - The
DAST_PATHS
variable has a limit of about 130kb. If you have a list or paths greater than this, useDAST_PATHS_FILE
.
Full Scan
To perform a full scan on the listed paths, use the DAST_FULL_SCAN_ENABLED
CI/CD variable.
Authentication
The proxy-based analyzer uses the browser-based analyzer to authenticate a user prior to a scan. See Authentication for configuration instructions.
Customize DAST settings
You can customize the behavior of DAST using both CI/CD variables and command-line options. Use of CI/CD variables overrides the values contained in the DAST template.
Customize DAST using CI/CD variables
WARNING:
Beginning in GitLab 13.0, the use of only
and except
is no longer supported. You must use rules
instead.
The DAST settings can be changed through CI/CD variables by using the
variables
parameter in .gitlab-ci.yml
. For details of
all DAST CI/CD variables, read Available CI/CD variables.
For example:
include:
- template: DAST.gitlab-ci.yml
variables:
DAST_WEBSITE: https://example.com
DAST_SPIDER_MINS: 120
DAST_BROWSER_SCAN: "true" # use the browser-based GitLab DAST crawler
Because the template is evaluated before the pipeline configuration, the last mention of the variable takes precedence.
Enable or disable rules
A complete list of the rules that DAST uses to scan for vulnerabilities can be found in the ZAP documentation.
DAST_EXCLUDE_RULES
disables the rules with the given IDs.
DAST_ONLY_INCLUDE_RULES
restricts the set of rules used in the scan to
those with the given IDs.
DAST_EXCLUDE_RULES
and DAST_ONLY_INCLUDE_RULES
are mutually exclusive and a
DAST scan with both configured exits with an error.
By default, several rules are disabled because they either take a long time to
run or frequently generate false positives. The complete list of disabled rules
can be found in exclude_rules.yml
.
The lists for DAST_EXCLUDE_RULES
and DAST_ONLY_INCLUDE_RULES
must be enclosed in double
quotes ("
), otherwise they are interpreted as numeric values.
Hide sensitive information
Introduced in GitLab 13.1.
HTTP request and response headers may contain sensitive information, including cookies and authorization credentials. By default, the following headers are masked:
-
Authorization
. -
Proxy-Authorization
. -
Set-Cookie
(values only). -
Cookie
(values only).
Using the DAST_MASK_HTTP_HEADERS
CI/CD variable, you can list the
headers whose values you want masked. For details on how to mask headers, see
Customizing the DAST settings.
Use Mutual TLS
Introduced in GitLab 14.8.
Mutual TLS allows a target application server to verify that requests are from a known source. Browser-based scans do not support Mutual TLS.
Requirements
- Base64-encoded PKCS12 certificate
- Password of the base64-encoded PKCS12 certificate
To enable Mutual TLS:
-
If the PKCS12 certificate is not already base64-encoded, convert it to base64 encoding. For security reasons, we recommend encoding the certificate locally, not using a web-hosted conversion service. For example, to encode the certificate on either macOS or Linux:
base64 <path-to-pkcs12-certificate-file>
-
Create a masked variable named
DAST_PKCS12_CERTIFICATE_BASE64
and store the base64-encoded PKCS12 certificate's value in that variable. -
Create a masked variable
DAST_PKCS12_PASSWORD
and store the PKCS12 certificate's password in that variable.
Available CI/CD variables
These CI/CD variables are specific to DAST. They can be used to customize the behavior of DAST to your requirements. For authentication CI/CD variables, see Authentication.
WARNING: All customization of GitLab security scanning tools should be tested in a merge request before merging these changes to the default branch. Failure to do so can give unexpected results, including a large number of false positives.
CI/CD variable | Type | Description |
---|---|---|
DAST_ADVERTISE_SCAN |
boolean | Set to true to add a Via header to every request sent, advertising that the request was sent as part of a GitLab DAST scan. Introduced in GitLab 14.1. |
DAST_AGGREGATE_VULNERABILITIES |
boolean | Vulnerability aggregation is set to true by default. To disable this feature and see each vulnerability individually set to false . Introduced in GitLab 14.0. |
DAST_API_HOST_OVERRIDE 1
|
string |
{warning} Deprecated in GitLab 15.7. Replaced by DAST API scan. Used to override domains defined in API specification files. Only supported when importing the API specification from a URL. Example: example.com:8080 . |
DAST_API_SPECIFICATION 1
|
URL or string |
{warning} Deprecated in GitLab 15.7. Replaced by DAST API scan. The API specification to import. The specification can be hosted at a URL, or the name of a file present in the /zap/wrk directory. The variable DAST_WEBSITE must be specified if this is omitted. |
DAST_AUTH_EXCLUDE_URLS |
URLs |
{warning} Removed in GitLab 14.0. Replaced by DAST_EXCLUDE_URLS . The URLs to skip during the authenticated scan; comma-separated. Regular expression syntax can be used to match multiple URLs. For example, .* matches an arbitrary character sequence. |
DAST_AUTO_UPDATE_ADDONS |
boolean | ZAP add-ons are pinned to specific versions in the DAST Docker image. Set to true to download the latest versions when the scan starts. Default: false . |
DAST_DEBUG 1
|
boolean | Enable debug message output. Default: false . Introduced in GitLab 13.1. |
DAST_EXCLUDE_RULES |
string | Set to a comma-separated list of Vulnerability Rule IDs to exclude them from running during the scan. Rule IDs are numbers and can be found from the DAST log or on the ZAP project. For example, HTTP Parameter Override has a rule ID of 10026 . Cannot be used when DAST_ONLY_INCLUDE_RULES is set. Note: In earlier versions of GitLab the excluded rules were executed but vulnerabilities they generated were suppressed. Introduced in GitLab 12.10. |
DAST_EXCLUDE_URLS 1
|
URLs | The URLs to skip during the authenticated scan; comma-separated. Regular expression syntax can be used to match multiple URLs. For example, .* matches an arbitrary character sequence. Example, http://example.com/sign-out . |
DAST_FULL_SCAN_DOMAIN_VALIDATION_REQUIRED |
boolean |
{warning} Removed in GitLab 14.0. Set to true to require domain validation when running DAST full scans. Default: false
|
DAST_FULL_SCAN_ENABLED 1
|
boolean | Set to true to run a ZAP Full Scan instead of a ZAP Baseline Scan. Default: false
|
DAST_HTML_REPORT |
string | {warning} Deprecated in GitLab 15.7. The filename of the HTML report written at the end of a scan. Introduced in GitLab 13.1. |
DAST_INCLUDE_ALPHA_VULNERABILITIES |
boolean | Set to true to include alpha passive and active scan rules. Default: false . Introduced in GitLab 13.1. |
DAST_MARKDOWN_REPORT |
string | {warning} Deprecated in GitLab 15.7. The filename of the Markdown report written at the end of a scan. Introduced in GitLab 13.1. |
DAST_MASK_HTTP_HEADERS |
string | Comma-separated list of request and response headers to be masked (GitLab 13.1). Must contain all headers to be masked. Refer to list of headers that are masked by default. |
DAST_MAX_URLS_PER_VULNERABILITY |
number | The maximum number of URLs reported for a single vulnerability. DAST_MAX_URLS_PER_VULNERABILITY is set to 50 by default. To list all the URLs set to 0 . Introduced in GitLab 13.12. |
DAST_ONLY_INCLUDE_RULES |
string | Set to a comma-separated list of Vulnerability Rule IDs to configure the scan to run only them. Rule IDs are numbers and can be found from the DAST log or on the ZAP project. Cannot be used when DAST_EXCLUDE_RULES is set. Introduced in GitLab 13.12. |
DAST_PATHS |
string | Set to a comma-separated list of URLs for DAST to scan. For example, /page1.html,/category1/page3.html,/page2.html . Introduced in GitLab 13.4. |
DAST_PATHS_FILE |
string | The file path containing the paths within DAST_WEBSITE to scan. The file must be plain text with one path per line. Introduced in GitLab 13.6. |
DAST_PKCS12_CERTIFICATE_BASE64 |
string | The PKCS12 certificate used for sites that require Mutual TLS. Must be encoded as base64 text. |
DAST_PKCS12_PASSWORD |
string | The password of the certificate used in DAST_PKCS12_CERTIFICATE_BASE64 . |
DAST_REQUEST_HEADERS 1
|
string | Set to a comma-separated list of request header names and values. Headers are added to every request made by DAST. For example, Cache-control: no-cache,User-Agent: DAST/1.0
|
DAST_SKIP_TARGET_CHECK |
boolean | Set to true to prevent DAST from checking that the target is available before scanning. Default: false . Introduced in GitLab 13.8. |
DAST_SPIDER_MINS 1
|
number | The maximum duration of the spider scan in minutes. Set to 0 for unlimited. Default: One minute, or unlimited when the scan is a full scan. Introduced in GitLab 13.1. |
DAST_SPIDER_START_AT_HOST |
boolean | Set to false to prevent DAST from resetting the target to its host before scanning. When true , non-host targets http://test.site/some_path is reset to http://test.site before scan. Default: true . Introduced in GitLab 13.6. |
DAST_TARGET_AVAILABILITY_TIMEOUT 1
|
number | Time limit in seconds to wait for target availability. |
DAST_USE_AJAX_SPIDER 1
|
boolean | Set to true to use the AJAX spider in addition to the traditional spider, useful for crawling sites that require JavaScript. Default: false . Introduced in GitLab 13.1. |
DAST_XML_REPORT |
string | {warning} Deprecated in GitLab 15.7. The filename of the XML report written at the end of a scan. Introduced in GitLab 13.1. |
DAST_WEBSITE 1
|
URL | The URL of the website to scan. |
DAST_ZAP_CLI_OPTIONS |
string |
{warning} Deprecated in GitLab 15.7. ZAP server command-line options. For example, -Xmx3072m would set the Java maximum memory allocation pool size. Introduced in GitLab 13.1. |
DAST_ZAP_LOG_CONFIGURATION |
string |
{warning} Deprecated in GitLab 15.7. Set to a semicolon-separated list of additional log4j properties for the ZAP Server. Example: logger.httpsender.name=org.parosproxy.paros.network.HttpSender;logger.httpsender.level=debug;logger.sitemap.name=org.parosproxy.paros.model.SiteMap;logger.sitemap.level=debug;
|
SECURE_ANALYZERS_PREFIX |
URL | Set the Docker registry base address from which to download the analyzer. |
- Available to an on-demand DAST scan.
Customize DAST using command-line options
Not all DAST configuration is available via CI/CD variables. To find out all possible options, run the following configuration. Available command-line options are printed to the job log:
include:
template: DAST.gitlab-ci.yml
dast:
script:
- /analyze --help
You must then overwrite the script
command to pass in the appropriate
argument. For example, vulnerability definitions in alpha can be included with
-a
. The following configuration includes those definitions:
include:
template: DAST.gitlab-ci.yml
dast:
script:
- export DAST_WEBSITE=${DAST_WEBSITE:-$(cat environment_url.txt)}
- /analyze -a -t $DAST_WEBSITE
Custom ZAProxy configuration
The ZAProxy server contains many useful configurable values.
Many key/values for -config
remain undocumented, but there is an untested list of
possible keys.
Note that these options are not supported by DAST, and may break the DAST scan
when used. An example of how to rewrite the Authorization header value with TOKEN
follows:
include:
template: DAST.gitlab-ci.yml
variables:
DAST_ZAP_CLI_OPTIONS: "-config replacer.full_list(0).description=auth -config replacer.full_list(0).enabled=true -config replacer.full_list(0).matchtype=REQ_HEADER -config replacer.full_list(0).matchstr=Authorization -config replacer.full_list(0).regex=false -config replacer.full_list(0).replacement=TOKEN"
Bleeding-edge vulnerability definitions
ZAP first creates rules in the alpha
class. After a testing period with
the community, they are promoted to beta
. DAST uses beta
definitions by
default. To request alpha
definitions, use the
DAST_INCLUDE_ALPHA_VULNERABILITIES
CI/CD variable as shown in the
following configuration:
include:
template: DAST.gitlab-ci.yml
variables:
DAST_INCLUDE_ALPHA_VULNERABILITIES: "true"
Cloning the project's repository
The DAST job does not require the project's repository to be present when running, so by default
GIT_STRATEGY
is set to none
.
On-demand scans
- Introduced in GitLab 13.2.
- Improved in GitLab 13.3.
- The saved scans feature was introduced in GitLab 13.9.
- The option to select a branch was introduced in GitLab 13.10.
- DAST branch selection feature flag removed in GitLab 13.11.
- Auditing for DAST profile management was introduced in GitLab 14.1.
An on-demand DAST scan runs outside the DevOps life cycle. Changes in your repository don't trigger the scan. You must either start it manually, or schedule it to run.
An on-demand DAST scan:
- Can run a specific combination of a site profile and a scanner profile.
- Is associated with your project's default branch.
- Is saved on creation so it can be run later.
An on-demand scan can be run in active or passive mode:
- Passive mode is the default and runs a ZAP Baseline Scan.
- Active mode runs a ZAP Full Scan which is potentially harmful to the site being scanned. To minimize the risk of accidental damage, running an active scan requires a validated site profile.
View on-demand DAST scans
To view on-demand scans, from your project's home page, go to Security & Compliance > On-demand scans in the left sidebar.
On-demand scans are grouped by their status. The scan library contains all available on-demand scans.
From the On-demand scans page you can:
- Run an on-demand scan.
- View the results of an on-demand scan.
- Cancel ({cancel}) a pending or running on-demand scan.
- Retry ({retry}) a scan that failed, or succeeded with warnings.
- Edit ({pencil}) an on-demand scan's settings.
- Delete an on-demand scan.
Run an on-demand DAST scan
Prerequisites:
- You must have permission to run an on-demand DAST scan against a protected branch. The default branch is automatically protected. For more information, read Pipeline security on protected branches.
- A scanner profile.
- A site profile.
- If you are running an active scan the site profile must have been validated.
You can run an on-demand scan immediately, once at a scheduled date and time or at a specified frequency:
- Every day
- Every week
- Every month
- Every 3 months
- Every 6 months
- Every year
To run an on-demand scan immediately, either:
To run an on-demand scan either at a scheduled date or frequency, read Schedule an on-demand scan.
Create and run an on-demand scan immediately
- From your project's home page, go to Security & Compliance > On-demand Scans in the left sidebar.
- Select New scan.
- Complete the Scan name and Description fields.
- In GitLab 13.10 and later, select the desired branch from the Branch dropdown list.
- In Scanner profile, select a scanner profile from the dropdown list.
- In Site profile, select a site profile from the dropdown list.
- To run the on-demand scan immediately, select Save and run scan. Otherwise, select Save scan to run it later.
The on-demand DAST scan runs and the project's dashboard shows the results.
Run a saved on-demand scan
To run a saved on-demand scan:
-
On the top bar, select Main menu > Projects and find your project.
-
On the left sidebar, select Security & Compliance > On-demand Scans.
-
Select the Scan library tab.
-
In the scan's row, select Run scan.
If the branch saved in the scan no longer exists, you must first edit the scan, select a new branch, and save the edited scan.
The on-demand DAST scan runs, and the project's dashboard shows the results.
Schedule an on-demand scan
- Introduced in GitLab 14.3. Deployed behind the
dast_on_demand_scans_scheduler
flag, disabled by default.- Enabled on GitLab.com in GitLab 14.4.
- Enabled on self-managed in GitLab 14.4.
- Feature flag
dast_on_demand_scans_scheduler
removed in GitLab 14.5.
To schedule a scan:
- On the top bar, select Main menu > Projects and find your project.
- On the left sidebar, select Security & Compliance > On-demand Scans.
- Select New scan.
- Complete the Scan name and Description text boxes.
- In GitLab 13.10 and later, from the Branch dropdown list, select the desired branch.
- In the Scanner profile section, from the dropdown list, select a scanner profile.
- In the Site profile section, from the dropdown list, select a site profile.
- Select Schedule scan.
- In the Start time section, select a time zone, date, and time.
- From the Repeats dropdown list, select your desired frequency:
- To run the scan once, select Never.
- For a recurring scan, select any other option.
- To run the on-demand scan immediately, select Save and run scan. To run it according to the schedule you set, select Save scan.
View details of an on-demand scan
To view details of an on-demand scan:
- From your project's home page, go to Security & Compliance > On-demand scans.
- Select the Scan library tab.
- In the saved scan's row select More actions ({ellipsis_v}), then select Edit.
Edit an on-demand scan
To edit an on-demand scan:
- From your project's home page, go to Security & Compliance > On-demand scans.
- Select the Scan library tab.
- In the saved scan's row select More actions ({ellipsis_v}), then select Edit.
- Edit the form.
- Select Save scan.
Delete an on-demand scan
To delete an on-demand scan:
- From your project's home page, go to Security & Compliance > On-demand scans.
- Select the Scan library tab.
- In the saved scan's row select More actions ({ellipsis_v}), then select Delete.
- On the confirmation dialog, select Delete.
Site profile
- Site profile features, scan method and file URL, were enabled on GitLab.com and self-managed in GitLab 15.6.
- GraphQL endpoint path feature was introduced in GitLab 15.7.
A site profile defines the attributes and configuration details of the deployed application,
website, or API to be scanned by DAST. A site profile can be referenced in .gitlab-ci.yml
and
on-demand scans.
A site profile contains:
-
Profile name: A name you assign to the site to be scanned. While a site profile is referenced in either
.gitlab-ci.yml
or an on-demand scan, it cannot be renamed. -
Site type: The type of target to be scanned, either website or API scan.
-
Target URL: The URL that DAST runs against.
-
Excluded URLs: A comma-separated list of URLs to exclude from the scan.
-
Request headers: A comma-separated list of HTTP request headers, including names and values. These headers are added to every request made by DAST.
-
Authentication:
- Authenticated URL: The URL of the page containing the sign-in HTML form on the target website. The username and password are submitted with the login form to create an authenticated scan.
- Username: The username used to authenticate to the website.
- Password: The password used to authenticate to the website.
- Username form field: The name of username field at the sign-in HTML form.
- Password form field: The name of password field at the sign-in HTML form.
-
Submit form field: The
id
orname
of the element that when selected submits the sign-in HTML form.
-
Scan method: A type of method to perform API testing. The supported methods are OpenAPI, Postman Collections, HTTP Archive (HAR), or GraphQL.
- GraphQL endpoint path: The path to the GraphQL endpoint. This path is concatenated with the target URL to provide the URI for the scan to test. The GraphQL endpoint must support introspection queries.
- File URL: The URL of the OpenAPI, Postman Collection, or HTTP Archive file.
When an API site type is selected, a host override is used to ensure the API being scanned is on the same host as the target. This is done to reduce the risk of running an active scan against the wrong API.
When configured, request headers and password fields are encrypted using aes-256-gcm
before being stored in the database.
This data can only be read and decrypted with a valid secrets file.
Site profile validation
- Site profile validation introduced in GitLab 13.8.
- Meta tag validation introduced in GitLab 14.2.
Site profile validation reduces the risk of running an active scan against the wrong website. A site must be validated before an active scan can run against it. The site validation methods are as follows:
- Text file validation requires a text file be uploaded to the target site. The text file is allocated a name and content that is unique to the project. The validation process checks the file's content.
-
Header validation requires the header
Gitlab-On-Demand-DAST
be added to the target site, with a value unique to the project. The validation process checks that the header is present, and checks its value. -
Meta tag validation requires the meta tag named
gitlab-dast-validation
be added to the target site, with a value unique to the project. Make sure it's added to the<head>
section of the page. The validation process checks that the meta tag is present, and checks its value.
All these methods are equivalent in functionality. Use whichever is feasible.
In GitLab 14.2 and later, site profile validation happens in a CI job using the GitLab Runner.
Create a site profile
To create a site profile:
- From your project's home page, go to Security & Compliance > Configuration.
- Select Manage in the DAST Profiles row.
- Select New > Site Profile.
- Complete the fields then select Save profile.
The site profile is created.
Edit a site profile
If a site profile is linked to a security policy, a user cannot edit the profile from this page. See Scan execution policies for more information.
When a validated site profile's file, header, or meta tag is edited, the site's validation status is revoked.
To edit a site profile:
- From your project's home page, go to Security & Compliance > Configuration.
- In the DAST Profiles row select Manage.
- Select the Site Profiles tab.
- In the profile's row select the More actions ({ellipsis_v}) menu, then select Edit.
- Edit the fields then select Save profile.
Delete a site profile
If a site profile is linked to a security policy, a user cannot delete the profile from this page. See Scan execution policies for more information.
To delete a site profile:
- From your project's home page, go to Security & Compliance > Configuration.
- In the DAST Profiles row select Manage.
- Select the Site Profiles tab.
- In the profile's row, select the More actions ({ellipsis_v}) menu, then select Delete.
- Select Delete to confirm the deletion.
Validate a site profile
Validating a site is required to run an active scan.
To validate a site profile:
- On the top bar, select Main menu > Projects and find your project.
- On the left sidebar, select Security & Compliance > Configuration.
- In the Dynamic Application Security Testing (DAST) section, select Manage profiles.
- Select the Site Profiles tab.
- In the profile's row, select Validate.
- Select the validation method.
- For Text file validation:
- Download the validation file listed in Step 2.
- Upload the validation file to the host, to the location in Step 3 or any location you prefer.
- If required, edit the file location in Step 3.
- Select Validate.
- For Header validation:
- Select the clipboard icon in Step 2.
- Edit the header of the site to validate, and paste the clipboard content.
- Select the input field in Step 3 and enter the location of the header.
- Select Validate.
- For Meta tag validation:
- Select the clipboard icon in Step 2.
- Edit the content of the site to validate, and paste the clipboard content.
- Select the input field in Step 3 and enter the location of the meta tag.
- Select Validate.
- For Text file validation:
The site is validated and an active scan can run against it. A site profile's validation status is revoked only when it's revoked manually, or its file, header, or meta tag is edited.
Retry a failed validation
- Introduced in GitLab 14.3.
- Deployed behind the
dast_failed_site_validations
flag, enabled by default.- Feature flag
dast_failed_site_validations
removed in GitLab 14.4.
Failed site validation attempts are listed on the Site profiles tab of the Manage profiles page.
To retry a site profile's failed validation:
- On the top bar, select Main menu > Projects and find your project.
- On the left sidebar, select Security & Compliance > Configuration.
- In the Dynamic Application Security Testing (DAST) section, select Manage profiles.
- Select the Site Profiles tab.
- In the profile's row, select Retry validation.
Revoke a site profile's validation status
WARNING: When a site profile's validation status is revoked, all site profiles that share the same URL also have their validation status revoked.
To revoke a site profile's validation status:
- From your project's home page, go to Security & Compliance > Configuration.
- In the DAST Profiles row select Manage.
- Beside the validated profile, select Revoke validation.
The site profile's validation status is revoked.
Validated site profile headers
The following are code samples of how you can provide the required site profile header in your application.
Ruby on Rails example for on-demand scan
Here's how you can add a custom header in a Ruby on Rails application:
class DastWebsiteTargetController < ActionController::Base
def dast_website_target
response.headers['Gitlab-On-Demand-DAST'] = '0dd79c9a-7b29-4e26-a815-eaaf53fcab1c'
head :ok
end
end
Django example for on-demand scan
Here's how you can add a custom header in Django:
class DastWebsiteTargetView(View):
def head(self, *args, **kwargs):
response = HttpResponse()
response['Gitlab-On-Demand-DAST'] = '0dd79c9a-7b29-4e26-a815-eaaf53fcab1c'
return response
Node (with Express) example for on-demand scan
Here's how you can add a custom header in Node (with Express):
app.get('/dast-website-target', function(req, res) {
res.append('Gitlab-On-Demand-DAST', '0dd79c9a-7b29-4e26-a815-eaaf53fcab1c')
res.send('Respond to DAST ping')
})
Scanner profile
- Introduced in GitLab 13.4.
- Added in GitLab 13.5: scan mode, AJAX spider, debug messages.
A scanner profile defines the configuration details of a security scanner. A scanner profile can be
referenced in .gitlab-ci.yml
and on-demand scans.
A scanner profile contains:
-
Profile name: A name you give the scanner profile. For example, "Spider_15". While a scanner
profile is referenced in either
.gitlab-ci.yml
or an on-demand scan, it cannot be renamed. - Scan mode: A passive scan monitors all HTTP messages (requests and responses) sent to the target. An active scan attacks the target to find potential vulnerabilities.
- Spider timeout: The maximum number of minutes allowed for the spider to traverse the site.
- Target timeout: The maximum number of seconds DAST waits for the site to be available before starting the scan.
- AJAX spider: Run the AJAX spider, in addition to the traditional spider, to crawl the target site.
- Debug messages: Include debug messages in the DAST console output.
Create a scanner profile
To create a scanner profile:
- From your project's home page, go to Security & Compliance > Configuration.
- In the DAST Profiles row, select Manage.
- Select New > Scanner Profile.
- Complete the form. For details of each field, see Scanner profile.
- Select Save profile.
Edit a scanner profile
If a scanner profile is linked to a security policy, a user cannot edit the profile from this page. See Scan execution policies for more information.
To edit a scanner profile:
- From your project's home page, go to Security & Compliance > Configuration.
- In the DAST Profiles row, select Manage.
- Select the Scanner Profiles tab.
- In the scanner's row, select the More actions ({ellipsis_v}) menu, then select Edit.
- Edit the form.
- Select Save profile.
Delete a scanner profile
If a scanner profile is linked to a security policy, a user cannot delete the profile from this page. See Scan execution policies for more information.
To delete a scanner profile:
- From your project's home page, go to Security & Compliance > Configuration.
- In the DAST Profiles row, select Manage.
- Select the Scanner Profiles tab.
- In the scanner's row, select the More actions ({ellipsis_v}) menu, then select Delete.
- Select Delete.
Auditing
Introduced in GitLab 14.1.
The creation, updating, and deletion of DAST profiles, DAST scanner profiles, and DAST site profiles are included in the audit log.
Reports
The DAST tool outputs a gl-dast-report.json
report file containing details of the scan and its results.
This file is included in the job's artifacts. JSON is the default format, but
you can output the report in Markdown, HTML, and XML formats. To specify an alternative
format, use a CI/CD variable.
For details of the report's schema, see the schema for DAST reports. Example reports can be found in the DAST repository.
WARNING: The JSON report artifacts are not a public API of DAST and their format is expected to change in the future.