debian-mirror-gitlab/doc/user/application_security/security_dashboard/index.md

214 lines
9.5 KiB
Markdown
Raw Normal View History

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
2019-12-04 20:38:33 +05:30
vulnerabilities in your groups, projects and pipelines.
2019-07-31 22:56:46 +05:30
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
2020-04-08 14:13:33 +05:30
To use the instance, group, project, or pipeline security dashboard:
2019-07-31 22:56:46 +05:30
1. At least one project inside a group must be configured with at least one of
the [supported reports](#supported-reports).
2020-05-24 23:13:21 +05:30
1. The configured jobs must use the [new `reports` syntax](../../../ci/pipelines/job_artifacts.md#artifactsreports).
2019-10-12 21:52:04 +05:30
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.
2020-04-22 19:07:51 +05:30
## Pipeline Security
2019-12-04 20:38:33 +05:30
2020-06-23 00:09:42 +05:30
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/13496) in [GitLab Ultimate](https://about.gitlab.com/pricing/) 12.3.
2019-12-04 20:38:33 +05:30
2020-04-22 19:07:51 +05:30
At the pipeline level, the Security section displays the vulnerabilities present in the branch of the project the pipeline was run against.
2019-12-04 20:38:33 +05:30
2020-04-22 19:07:51 +05:30
Visit the page for any pipeline which has run any of the [supported reports](#supported-reports). Click the **Security** tab to view the Security findings.
2019-12-04 20:38:33 +05:30
2020-01-01 13:55:28 +05:30
![Pipeline Security Dashboard](img/pipeline_security_dashboard_v12_6.png)
2019-12-04 20:38:33 +05:30
2020-05-24 23:13:21 +05:30
NOTE: **Note:**
A pipeline consists of multiple jobs, including SAST and DAST scanning. If any job fails to finish for any reason, the security dashboard will not show SAST scanner output. For example, if the SAST job finishes but the DAST job fails, the security dashboard will not show SAST results. The analyzer will output an [exit code](../../../development/integrations/secure.md#exit-code) on failure.
2019-07-31 22:56:46 +05:30
## Project Security Dashboard
2020-06-23 00:09:42 +05:30
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/6165) in [GitLab Ultimate](https://about.gitlab.com/pricing/) 11.1.
2019-07-31 22:56:46 +05:30
2020-05-24 23:13:21 +05:30
At the project level, the Security Dashboard displays the latest security reports for your project.
Use it to find and fix vulnerabilities.
2019-07-31 22:56:46 +05:30
2020-05-24 23:13:21 +05:30
![Project Security Dashboard](img/project_security_dashboard_v13_0.png)
2019-07-31 22:56:46 +05:30
2020-04-22 19:07:51 +05:30
### Export vulnerabilities
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/197494) in [GitLab Ultimate](https://about.gitlab.com/pricing/) 12.10.
You can export all your project's vulnerabilities as CSV by clicking on the export button located at top right of the Project Security Dashboard. This will initiate the process, and once complete, the CSV report will be downloaded. The report will contain all vulnerabilities in the project as filters won't apply.
NOTE: **Note:**
It may take several minutes for the download to start if your project consists
of thousands of vulnerabilities. Do not close the page until the download finishes.
2020-05-24 23:13:21 +05:30
![CSV Export Button](img/project_security_dashboard_export_csv_v12_10.png)
2020-04-22 19:07:51 +05:30
2019-07-31 22:56:46 +05:30
## Group Security Dashboard
2020-06-23 00:09:42 +05:30
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/6709) in [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:
2020-05-24 23:13:21 +05:30
- Status
2019-07-31 22:56:46 +05:30
- Severity
- Report type
2019-12-04 20:38:33 +05:30
NOTE: **Note:**
2020-05-24 23:13:21 +05:30
The dashboard only shows projects with [security reports](#supported-reports) enabled in a group.
2019-12-04 20:38:33 +05:30
2020-05-24 23:13:21 +05:30
![Dashboard with action buttons and metrics](img/group_security_dashboard_v13_0.png)
2019-07-31 22:56:46 +05:30
2020-05-24 23:13:21 +05:30
Selecting one or more filters will filter the results in this page.
2019-12-04 20:38:33 +05:30
The main section is a list of all the vulnerabilities in the group, sorted by severity.
2019-07-31 22:56:46 +05:30
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.
2020-05-24 23:13:21 +05:30
If you hover over a row, the following actions appear:
2019-07-31 22:56:46 +05:30
2020-05-24 23:13:21 +05:30
- More info
- Create issue
- Dismiss vulnerability
2019-07-31 22:56:46 +05:30
2019-12-04 20:38:33 +05:30
Next to the list 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.
2020-01-01 13:55:28 +05:30
Below the timeline chart is a list of projects, grouped and sorted by the severity of the vulnerability found:
- F: 1 or more "critical"
- D: 1 or more "high" or "unknown"
- C: 1 or more "medium"
- B: 1 or more "low"
- A: 0 vulnerabilities
Projects with no vulnerability tests configured will not appear in the list. Additionally, dismissed
vulnerabilities are not included either.
2019-07-31 22:56:46 +05:30
Read more on how to [interact with the vulnerabilities](../index.md#interacting-with-the-vulnerabilities).
2020-06-23 00:09:42 +05:30
### Export vulnerabilities
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/213013) in [GitLab Ultimate](https://about.gitlab.com/pricing/) 13.1.
You can export all your vulnerabilities as CSV by clicking the **{upload}** **Export** button
located at the top right of the **Group Security Dashboard**. After the report builds, the CSV
report downloads to your local machine. The report contains all vulnerabilities for the projects
defined in the **Group Security Dashboard**, as filters don't apply to the export function.
NOTE: **Note:**
It may take several minutes for the download to start if your project contains thousands of
vulnerabilities. Don't close the page until the download finishes.
![CSV Export Button](img/group_security_dashboard_export_csv_v13_1.png)
2020-03-13 15:44:24 +05:30
## Instance Security Dashboard
2020-06-23 00:09:42 +05:30
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/6953) in [GitLab Ultimate](https://about.gitlab.com/pricing/) 12.8.
2020-03-13 15:44:24 +05:30
At the instance level, the Security Dashboard displays the vulnerabilities
present in all of the projects that you have added to it. It includes all
of the features of the [group security dashboard](#group-security-dashboard).
You can access the Instance Security Dashboard from the menu
bar at the top of the page. Under **More**, select **Security**.
![Instance Security Dashboard navigation link](img/instance_security_dashboard_link_v12_4.png)
### Adding projects to the dashboard
To add projects to the dashboard:
1. Click the **Edit dashboard** button on the Instance Security Dashboard page.
1. Search for and add one or more projects using the **Search your projects** field.
1. Click the **Add projects** button.
Once added, the dashboard will display the vulnerabilities found in your chosen
projects.
2020-05-24 23:13:21 +05:30
![Instance Security Dashboard with projects](img/instance_security_dashboard_with_projects_v13_0.png)
### Export vulnerabilities
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/213014) in [GitLab Ultimate](https://about.gitlab.com/pricing/) 13.0.
You can export all your vulnerabilities as CSV by clicking the **{upload}** **Export**
button located at top right of the **Instance Security Dashboard**. After the report
is built, the CSV report downloads to your local machine. The report contains all
vulnerabilities for the projects defined in the **Instance Security Dashboard**,
as filters don't apply to the export function.
NOTE: **Note:**
It may take several minutes for the download to start if your project contains
thousands of vulnerabilities. Do not close the page until the download finishes.
![CSV Export Button](img/instance_security_dashboard_export_csv_v13_0.png)
2020-03-13 15:44:24 +05:30
2019-07-31 22:56:46 +05:30
## 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,
2020-04-08 14:13:33 +05:30
[configure a scheduled pipeline](../../../ci/pipelines/schedules.md) to run a
2019-07-31 22:56:46 +05:30
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
2020-04-22 19:07:51 +05:30
[special environment variables](../../../topics/autodevops/customize.md#environment-variables)
2019-07-31 22:56:46 +05:30
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. -->