2019-10-12 21:52:04 +05:30
|
|
|
---
|
|
|
|
type: reference, howto
|
|
|
|
---
|
|
|
|
|
2019-09-30 21:07:59 +05:30
|
|
|
# GitLab Security Dashboard **(ULTIMATE)**
|
2019-07-31 22:56:46 +05:30
|
|
|
|
|
|
|
The Security Dashboard is a good place to get an overview of all the security
|
|
|
|
vulnerabilities in your groups and projects.
|
|
|
|
|
|
|
|
You can also drill down into a vulnerability and get extra information, see which
|
|
|
|
project it comes from, the file it's in, and various metadata to help you analyze
|
|
|
|
the risk. You can also action these vulnerabilities by creating an issue for them,
|
|
|
|
or by dismissing them.
|
|
|
|
|
|
|
|
To benefit from the Security Dashboard you must first configure one of the
|
|
|
|
[security reports](../index.md).
|
|
|
|
|
|
|
|
## Supported reports
|
|
|
|
|
|
|
|
The Security Dashboard supports the following reports:
|
|
|
|
|
|
|
|
- [Container Scanning](../container_scanning/index.md)
|
2019-10-12 21:52:04 +05:30
|
|
|
- [Dynamic Application Security Testing](../dast/index.md)
|
2019-07-31 22:56:46 +05:30
|
|
|
- [Dependency Scanning](../dependency_scanning/index.md)
|
2019-10-12 21:52:04 +05:30
|
|
|
- [Static Application Security Testing](../sast/index.md)
|
2019-07-31 22:56:46 +05:30
|
|
|
|
|
|
|
## Requirements
|
|
|
|
|
|
|
|
To use the project or group security dashboard:
|
|
|
|
|
|
|
|
1. At least one project inside a group must be configured with at least one of
|
|
|
|
the [supported reports](#supported-reports).
|
2019-10-12 21:52:04 +05:30
|
|
|
1. The configured jobs must use the [new `reports` syntax](../../../ci/yaml/README.md#artifactsreports).
|
|
|
|
1. [GitLab Runner](https://docs.gitlab.com/runner/) 11.5 or newer must be used.
|
2019-07-31 22:56:46 +05:30
|
|
|
If you're using the shared Runners on GitLab.com, this is already the case.
|
|
|
|
|
|
|
|
## Project Security Dashboard
|
|
|
|
|
|
|
|
> [Introduced](https://gitlab.com/gitlab-org/gitlab-ee/issues/6165) in [GitLab Ultimate](https://about.gitlab.com/pricing) 11.1.
|
|
|
|
|
|
|
|
At the project level, the Security Dashboard displays the latest security reports
|
|
|
|
for your project. Use it to find and fix vulnerabilities affecting the
|
|
|
|
[default branch](../../project/repository/branches/index.md#default-branch).
|
|
|
|
|
|
|
|
![Project Security Dashboard](img/project_security_dashboard.png)
|
|
|
|
|
|
|
|
## Group Security Dashboard
|
|
|
|
|
|
|
|
> [Introduced](https://gitlab.com/gitlab-org/gitlab-ee/issues/6709) in
|
2019-10-12 21:52:04 +05:30
|
|
|
> [GitLab Ultimate](https://about.gitlab.com/pricing) 11.5.
|
2019-07-31 22:56:46 +05:30
|
|
|
|
|
|
|
The group Security Dashboard gives an overview of the vulnerabilities of all the
|
|
|
|
projects in a group and its subgroups.
|
|
|
|
|
|
|
|
First, navigate to the Security Dashboard found under your group's
|
2019-10-12 21:52:04 +05:30
|
|
|
**Security** tab.
|
2019-07-31 22:56:46 +05:30
|
|
|
|
|
|
|
Once you're on the dashboard, at the top you should see a series of filters for:
|
|
|
|
|
|
|
|
- Severity
|
2019-09-04 21:01:54 +05:30
|
|
|
- Confidence
|
2019-07-31 22:56:46 +05:30
|
|
|
- Report type
|
|
|
|
- Project
|
|
|
|
|
2019-10-12 21:52:04 +05:30
|
|
|
![dashboard with action buttons and metrics](img/group_security_dashboard.png)
|
2019-07-31 22:56:46 +05:30
|
|
|
|
|
|
|
Selecting one or more filters will filter the results in this page.
|
|
|
|
The first section is an overview of all the vulnerabilities, grouped by severity.
|
|
|
|
Underneath this overview is a timeline chart that shows how many open
|
|
|
|
vulnerabilities your projects had at various points in time. You can filter among 30, 60, and
|
|
|
|
90 days, with the default being 90. Hover over the chart to get more details about
|
|
|
|
the open vulnerabilities at a specific time.
|
|
|
|
|
|
|
|
Finally, there is a list of all the vulnerabilities in the group, sorted by severity.
|
|
|
|
In that list, you can see the severity of the vulnerability, its name, its
|
|
|
|
confidence (likelihood of the vulnerability to be a positive one), and the project
|
|
|
|
it's from.
|
|
|
|
|
|
|
|
If you hover over a row, there will appear some actions you can take:
|
|
|
|
|
|
|
|
- "More info"
|
|
|
|
- "Create issue"
|
|
|
|
- "Dismiss vulnerability"
|
|
|
|
|
|
|
|
Read more on how to [interact with the vulnerabilities](../index.md#interacting-with-the-vulnerabilities).
|
|
|
|
|
|
|
|
## Keeping the dashboards up to date
|
|
|
|
|
|
|
|
The Security Dashboard displays information from the results of the most recent
|
|
|
|
security scan on the [default branch](../../project/repository/branches/index.md#default-branch),
|
|
|
|
which means that security scans are performed every time the branch is updated.
|
|
|
|
|
|
|
|
If the default branch is updated infrequently, scans are run infrequently and the
|
|
|
|
information on the Security Dashboard can become outdated as new vulnerabilities
|
|
|
|
are discovered.
|
|
|
|
|
|
|
|
To ensure the information on the Security Dashboard is regularly updated,
|
|
|
|
[configure a scheduled pipeline](../../project/pipelines/schedules.md) to run a
|
|
|
|
daily security scan. This will update the information displayed on the Security
|
|
|
|
Dashboard regardless of how often the default branch is updated.
|
|
|
|
|
|
|
|
That way, reports are created even if no code change happens.
|
|
|
|
|
|
|
|
## Security scans using Auto DevOps
|
|
|
|
|
|
|
|
When using [Auto DevOps](../../../topics/autodevops/index.md), use
|
|
|
|
[special environment variables](../../../topics/autodevops/index.md#environment-variables)
|
|
|
|
to configure daily security scans.
|
2019-10-12 21:52:04 +05:30
|
|
|
|
|
|
|
<!-- ## Troubleshooting
|
|
|
|
|
|
|
|
Include any troubleshooting steps that you can foresee. If you know beforehand what issues
|
|
|
|
one might have when setting this up, or when something is changed, or on upgrading, it's
|
|
|
|
important to describe those, too. Think of things that may go wrong and include them here.
|
|
|
|
This is important to minimize requests for support, and to avoid doc comments with
|
|
|
|
questions that you know someone might ask.
|
|
|
|
|
|
|
|
Each scenario can be a third-level heading, e.g. `### Getting error message X`.
|
|
|
|
If you have none to add when creating a doc, leave this section in place
|
|
|
|
but commented out to help encourage others to add to it in the future. -->
|