Commit 4fa94b89 authored by Michael Eddington's avatar Michael Eddington Committed by Nick Gaskill

Document API Fuzzing security report

parent bb0819de
...@@ -720,45 +720,43 @@ Repeat this configuration for each profile as needed. ...@@ -720,45 +720,43 @@ Repeat this configuration for each profile as needed.
## Running your first scan ## Running your first scan
When configured correctly, a CI/CD pipeline contains a `Fuzz` stage and a `apifuzzer_fuzz` job. The When configured correctly, a CI/CD pipeline contains a `fuzz` stage and an `apifuzzer_fuzz` or
job only fails when an invalid configuration is provided. During normal operation, the job always `apifuzzer_fuzz_dnd` job. The job only fails when an invalid configuration is provided. During
succeeds even if faults are identified during fuzz testing. normal operation, the job always succeeds even if faults are identified during fuzz testing.
Faults are displayed on the **Tests** pipeline tab with the suite name **API-Fuzzing**. The **Name** Faults are displayed on the **Security** pipeline tab with the suite name. When testing against the
field on the **Tests** page includes the fuzz-tested operation and parameter. The **Trace** field repositories default branch, the fuzzing faults are also shown on the Security & Compliance's
contains a writeup of the identified fault. This writeup contains information on what the fuzzer Vulnerability Report page.
tested and how it detected something wrong.
To prevent an excessive number of reported faults, the API fuzzing scanner limits the number of To prevent an excessive number of reported faults, the API fuzzing scanner limits the number of
faults it reports to one per parameter. faults it reports.
### Fault Writeup ## Viewing fuzzing faults
The faults that API fuzzing finds aren't associated with a specific vulnerability type. They require The API Fuzzing analyzer produces a JSON report that is collected and used
investigation to determine what type of issue they are and if they should be fixed. See [to populate the faults into GitLab's vulnerability screens](../index.md#view-details-of-an-api-fuzzing-vulnerability).
[handling false positives](#handling-false-positives) for information about configuration changes Fuzzing faults show up as vulnerabilities with a severity of Unknown.
you can make to limit the number of false positives reported.
The faults that API fuzzing finds require manual investigation and aren't associated with a specific
This table contains a description of fields in an API fuzzing fault writeup. vulnerability type. They require investigation to determine if they are a security issue, and if
they should be fixed. See [handling false positives](#handling-false-positives)
| Writeup Item | Description | for information about configuration changes you can make to limit the number of false positives
|:-------------|:------------| reported.
| Operation | The operation tested. |
| Parameter | The field modified. This can be a path segment, header, query string, or body element. | For additional information, see
| Endpoint | The endpoint being tested. | [View details of an API Fuzzing vulnerability](../index.md#view-details-of-an-api-fuzzing-vulnerability).
| Check | Check module producing the test. Checks can be turned on and off. |
| Assert | Assert module that detected a failure. Assertions can be configured and turned on and off. | ### Security Dashboard
| CWE | Fuzzing faults always have the same CWE. |
| OWASP | Fuzzing faults always have the same OWASP ID. | Fuzzing faults show up as vulnerabilities with a severity of Unknown. The Security Dashboard is a
| Exploitability | Fuzzing faults always have an `unknown` exploitability. | good place to get an overview of all the security vulnerabilities in your groups, projects and
| Impact | Fuzzing faults always have an `unknown` risk impact. | pipelines. For more information, see the [Security Dashboard documentation](../security_dashboard/index.md).
| Description | Verbose description of what the check did. Includes the original parameter value and the modified (mutated) value. |
| Detection | Why a failure was detected and reported. This is related to the Assert that was used. | ### Interacting with the vulnerabilities
| Original Request | The original, unmodified HTTP request. Useful when reviewing the actual request to see what changes were made. |
| Actual Request | The request that produced the failure. This request has been modified in some way by the Check logic. | Fuzzing faults show up as vulnerabilities with a severity of Unknown.
| Actual Response | The response to the actual request. | Once a fault is found, you can interact with it. Read more on how to
| Recorded Request | An unmodified request. | [interact with the vulnerabilities](../index.md#interacting-with-the-vulnerabilities).
| Recorded Response | The response to the unmodified request. You can compare this with the actual request when triaging this fault. |
## Handling False Positives ## Handling False Positives
......
...@@ -201,6 +201,43 @@ authorization credentials. By default, content of specific headers are masked in ...@@ -201,6 +201,43 @@ authorization credentials. By default, content of specific headers are masked in
reports. You can specify the list of all headers to be masked. For details, see reports. You can specify the list of all headers to be masked. For details, see
[Hide sensitive information](dast/index.md#hide-sensitive-information). [Hide sensitive information](dast/index.md#hide-sensitive-information).
### View details of an API Fuzzing vulnerability
> Introduced in [GitLab Ultimate](https://about.gitlab.com/pricing/) 13.7.
Faults detected by API Fuzzing occur in the live web application, and require manual investigation
to determine if they are vulnerabilities. Fuzzing faults are included as vulnerabilities with a
severity of Unknown. To facilitate investigation of the fuzzing faults, detailed information is
provided about the HTTP messages sent and received along with a description of the modification(s)
made.
Follow these steps to view details of a fuzzing fault:
1. You can view faults in a project, or a merge request:
- In a project, go to the project's **{shield}** **Security & Compliance > Vulnerability Report**
page. This page shows all vulnerabilities from the default branch only.
- In a merge request, go the merge request's **Security** section and click the **Expand**
button. API Fuzzing faults are available in a section labeled
**API Fuzzing detected N potential vulnerabilities**. Click the title to display the fault
details.
1. Click the fault's title to display the fault's details. The table below describes these details.
| Field | Description |
|:-----------------|:------------------------------------------------------------------ |
| Description | Description of the fault including what was modified. |
| Project | Namespace and project in which the vulnerability was detected. |
| Method | HTTP method used to detect the vulnerability. |
| URL | URL at which the vulnerability was detected. |
| Request | The HTTP request that caused the fault. |
| Unmodified Response | Response from an unmodified request. This is what a normal working response looks like. |
| Actual Response | Response received from fuzzed request. |
| Evidence | How we determined a fault occurred. |
| Identifiers | The fuzzing check used to find this fault. |
| Severity | Severity of the finding is always Unknown. |
| Scanner Type | Scanner used to perform testing. |
### Dismissing a vulnerability ### Dismissing a vulnerability
To dismiss a vulnerability, you must set its status to Dismissed. This dismisses the vulnerability To dismiss a vulnerability, you must set its status to Dismissed. This dismisses the vulnerability
......
---
title: API Fuzzing results integrated with vulnerability management
merge_request: 50112
author:
type: added
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment