Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
G
gitlab-ce
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
1
Merge Requests
1
Analytics
Analytics
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Commits
Issue Boards
Open sidebar
nexedi
gitlab-ce
Commits
4fa94b89
Commit
4fa94b89
authored
Dec 16, 2020
by
Michael Eddington
Committed by
Nick Gaskill
Dec 16, 2020
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Document API Fuzzing security report
parent
bb0819de
Changes
3
Hide whitespace changes
Inline
Side-by-side
Showing
3 changed files
with
76 additions
and
36 deletions
+76
-36
doc/user/application_security/api_fuzzing/index.md
doc/user/application_security/api_fuzzing/index.md
+34
-36
doc/user/application_security/index.md
doc/user/application_security/index.md
+37
-0
ee/changelogs/unreleased/270207-api-fuzzing-report-docs.yml
ee/changelogs/unreleased/270207-api-fuzzing-report-docs.yml
+5
-0
No files found.
doc/user/application_security/api_fuzzing/index.md
View file @
4fa94b89
...
...
@@ -720,45 +720,43 @@ Repeat this configuration for each profile as needed.
## Running your first scan
When configured correctly, a CI/CD pipeline contains a
`
Fuzz`
stage and a
`apifuzzer_fuzz`
job. The
job only fails when an invalid configuration is provided. During normal operation, the job always
succeeds even if faults are identified during fuzz testing.
When configured correctly, a CI/CD pipeline contains a
`
fuzz`
stage and an
`apifuzzer_fuzz`
or
`apifuzzer_fuzz_dnd`
job. The job only fails when an invalid configuration is provided. During
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**
field on the
**Tests**
page includes the fuzz-tested operation and parameter. The
**Trace**
field
contains a writeup of the identified fault. This writeup contains information on what the fuzzer
tested and how it detected something wrong.
Faults are displayed on the
**Security**
pipeline tab with the suite name. When testing against the
repositories default branch, the fuzzing faults are also shown on the Security & Compliance's
Vulnerability Report page.
To prevent an excessive number of reported faults, the API fuzzing scanner limits the number of
faults it reports to one per parameter.
### Fault Writeup
The faults that API fuzzing finds aren't associated with a specific vulnerability type. They require
investigation to determine what type of issue they are and if they should be fixed. See
[
handling false positives
](
#handling-false-positives
)
for information about configuration changes
you can make to limit the number of false positives reported.
This table contains a description of fields in an API fuzzing fault writeup.
| Writeup Item | Description |
|:-------------|:------------|
| Operation | The operation tested. |
| Parameter | The field modified. This can be a path segment, header, query string, or body element. |
| Endpoint | The endpoint being tested. |
| 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. |
| CWE | Fuzzing faults always have the same CWE. |
| OWASP | Fuzzing faults always have the same OWASP ID. |
| Exploitability | Fuzzing faults always have an
`unknown`
exploitability. |
| Impact | Fuzzing faults always have an
`unknown`
risk impact. |
| 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. |
| 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. |
| Actual Response | The response to the actual request. |
| Recorded Request | An unmodified request. |
| Recorded Response | The response to the unmodified request. You can compare this with the actual request when triaging this fault. |
faults it reports.
## Viewing fuzzing faults
The API Fuzzing analyzer produces a JSON report that is collected and used
[
to populate the faults into GitLab's vulnerability screens
](
../index.md#view-details-of-an-api-fuzzing-vulnerability
)
.
Fuzzing faults show up as vulnerabilities with a severity of Unknown.
The faults that API fuzzing finds require manual investigation and aren't associated with a specific
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
)
for information about configuration changes you can make to limit the number of false positives
reported.
For additional information, see
[
View details of an API Fuzzing vulnerability
](
../index.md#view-details-of-an-api-fuzzing-vulnerability
)
.
### Security Dashboard
Fuzzing faults show up as vulnerabilities with a severity of Unknown. The Security Dashboard is a
good place to get an overview of all the security vulnerabilities in your groups, projects and
pipelines. For more information, see the
[
Security Dashboard documentation
](
../security_dashboard/index.md
)
.
### Interacting with the vulnerabilities
Fuzzing faults show up as vulnerabilities with a severity of Unknown.
Once a fault is found, you can interact with it. Read more on how to
[
interact with the vulnerabilities
](
../index.md#interacting-with-the-vulnerabilities
)
.
## Handling False Positives
...
...
doc/user/application_security/index.md
View file @
4fa94b89
...
...
@@ -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
[
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
To dismiss a vulnerability, you must set its status to Dismissed. This dismisses the vulnerability
...
...
ee/changelogs/unreleased/270207-api-fuzzing-report-docs.yml
0 → 100644
View file @
4fa94b89
---
title
:
API Fuzzing results integrated with vulnerability management
merge_request
:
50112
author
:
type
:
added
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment