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
5a35a8eb
Commit
5a35a8eb
authored
Apr 27, 2020
by
Tetiana Chupryna
Committed by
Russell Dickenson
Apr 27, 2020
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Docs - Explain remediations better
parent
cf4af500
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
43 additions
and
4 deletions
+43
-4
doc/development/integrations/secure.md
doc/development/integrations/secure.md
+43
-4
No files found.
doc/development/integrations/secure.md
View file @
5a35a8eb
...
...
@@ -470,18 +470,57 @@ Valid values are: `Ignore`, `Unknown`, `Experimental`, `Low`, `Medium`, `High`,
### Remediations
The
`remediations`
field of the report is an array of remediation objects.
Each remediation describes a patch that can be applied to automatically fix
Each remediation describes a patch that can be applied to
[
automatically fix
](
../../user/application_security/#solutions-for-vulnerabilities-auto-remediation
)
a set of vulnerabilities.
Here is an example of a report that contains remediations.
```
json
{
"vulnerabilities"
:
[
{
"category"
:
"dependency_scanning"
,
"name"
:
"Regular Expression Denial of Service"
,
"id"
:
"123e4567-e89b-12d3-a456-426655440000"
,
"solution"
:
"Upgrade to new versions."
,
"scanner"
:
{
"id"
:
"gemnasium"
,
"name"
:
"Gemnasium"
},
"identifiers"
:
[
{
"type"
:
"gemnasium"
,
"name"
:
"Gemnasium-642735a5-1425-428d-8d4e-3c854885a3c9"
,
"value"
:
"642735a5-1425-428d-8d4e-3c854885a3c9"
}
]
}
],
"remediations"
:
[
{
"fixes"
:
[
{
"id"
:
"123e4567-e89b-12d3-a456-426655440000"
}
],
"summary"
:
"Upgrade to new version"
,
"diff"
:
"ZGlmZiAtLWdpdCBhL3lhcm4ubG9jayBiL3lhcm4ubG9jawppbmRleCAwZWNjOTJmLi43ZmE0NTU0IDEwMDY0NAotLS0gYS95Y=="
}
]
}
```
#### Summary
The
`summary`
field is an overview of how the vulnerabilities can be fixed.
The
`summary`
field is an overview of how the vulnerabilities can be fixed.
This field is required.
#### Fixed vulnerabilities
The
`fixes`
field is an array of objects that reference the vulnerabilities fixed by the
remediation.
`fixes[].id`
contains a fixed vulnerability's
unique identifier
.
remediation.
`fixes[].id`
contains a fixed vulnerability's
[
unique identifier
](
#id
)
. This field is required
.
#### Diff
The
`diff`
field is a base64-encoded remediation code diff, compatible with
[
`git apply`
](
https://git-scm.com/docs/git-format-patch#_discussion
)
.
The
`diff`
field is a base64-encoded remediation code diff, compatible with
[
`git apply`
](
https://git-scm.com/docs/git-format-patch#_discussion
)
. This field is required.
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