index.md 10.2 KB
Newer Older
1 2
---
type: reference, howto
3 4 5
stage: Secure
group: Threat Insights
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#designated-technical-writers
6 7
---

8
# GitLab Security Dashboard **(ULTIMATE)**
9 10

The Security Dashboard is a good place to get an overview of all the security
11
vulnerabilities in your groups, projects and pipelines.
12 13 14

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
15
the risk. You can also take actions on vulnerabilities by creating an issue for them,
16 17 18 19 20 21 22 23 24 25
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)
26
- [Dynamic Application Security Testing](../dast/index.md)
27
- [Dependency Scanning](../dependency_scanning/index.md)
28
- [Static Application Security Testing](../sast/index.md)
29 30 31

## Requirements

32
To use the instance, group, project, or pipeline security dashboard:
33 34 35

1. At least one project inside a group must be configured with at least one of
   the [supported reports](#supported-reports).
36
1. The configured jobs must use the [new `reports` syntax](../../../ci/pipelines/job_artifacts.md#artifactsreports).
37
1. [GitLab Runner](https://docs.gitlab.com/runner/) 11.5 or newer must be used.
38 39
   If you're using the shared Runners on GitLab.com, this is already the case.

40
## Pipeline Security
41

42
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/13496) in [GitLab Ultimate](https://about.gitlab.com/pricing/) 12.3.
43

44
At the pipeline level, the Security section displays the vulnerabilities present in the branch of the project the pipeline was run against.
45

46
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.
47

48
![Pipeline Security Dashboard](img/pipeline_security_dashboard_v13_2.png)
49

50 51 52
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.

53 54
## Project Security Dashboard

55
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/6165) in [GitLab Ultimate](https://about.gitlab.com/pricing/) 11.1.
56

57 58
At the project level, the Security Dashboard displays the vulnerabilities merged into your project's
[default branch](../../project/repository/branches/index.md#default-branch). Access it by navigating
59 60
to **Security & Compliance > Security Dashboard**. By default, the Security Dashboard displays all
detected and confirmed vulnerabilities.
61

62 63 64 65
The Security Dashboard first displays the total number of vulnerabilities by severity (for example,
Critical, High, Medium, Low). Below this, a table displays each vulnerability's status, severity,
and description. Clicking a vulnerability takes you to its [Vulnerability Details](../vulnerabilities)
page to view more information about that vulnerability.
66

67
You can filter the vulnerabilities by:
68

69 70 71
- Status
- Severity
- Report type
72

73
You can also dismiss vulnerabilities in the table:
74

75 76
1. Select the checkbox for each vulnerability you want to dismiss.
1. In the menu that appears, select the reason for dismissal and click **Dismiss Selected**.
77

78
![Project Security Dashboard](img/project_security_dashboard_v13_2.png)
79

80 81
## Group Security Dashboard

82
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/6709) in [GitLab Ultimate](https://about.gitlab.com/pricing/) 11.5.
83

84 85
The group Security Dashboard gives an overview of the vulnerabilities in the default branches of the
projects in a group and its subgroups. Access it by navigating to **Security > Security Dashboard**
86 87
for your group. By default, the Security Dashboard displays all detected and confirmed
vulnerabilities.
88 89 90 91

NOTE: **Note:**
The Security Dashboard only shows projects with [security reports](#supported-reports) enabled in a
group.
92

93
![Dashboard with action buttons and metrics](img/group_security_dashboard_v13_2_noNav.png)
94

95
You can filter which vulnerabilities the Security Dashboard displays by:
96

97
- Status
98 99
- Severity
- Report type
100
- Project
101

102 103 104
A table lists the vulnerabilities, sorted by severity. The table shows each vulnerability's status,
severity, and description. Clicking a vulnerability takes you to its [Vulnerability Details](../vulnerabilities)
page to view more information about that vulnerability.
105

106 107 108 109 110
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.

111 112 113 114 115 116 117 118 119 120 121
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.

122 123
Read more on how to [interact with the vulnerabilities](../index.md#interacting-with-the-vulnerabilities).

124 125
## Instance Security Dashboard

126
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/6953) in [GitLab Ultimate](https://about.gitlab.com/pricing/) 12.8.
127

128 129 130 131
At the instance level, the Security Dashboard displays the vulnerabilities present in the default
branches of all the projects you configure to display on the dashboard. It includes all the
[group Security Dashboard's](#group-security-dashboard)
features.
132 133 134 135 136 137 138 139 140 141 142 143 144 145

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.

146 147
Once added, the Security Dashboard displays the vulnerabilities found in your chosen projects'
default branches.
148

149
![Instance Security Dashboard with projects](img/instance_security_dashboard_with_projects_v13_2_sm.png)
150

151
## Export vulnerabilities
152

153
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/213014) in [GitLab Ultimate](https://about.gitlab.com/pricing/) 12.10.
154

155 156
You can export all your vulnerabilities in CSV format by clicking the **{upload}** **Export**
button located at top right of the **Security Dashboard**. After the report
157
is built, the CSV report downloads to your local machine. The report contains all
158
vulnerabilities for the projects defined in the **Security Dashboard**,
159 160 161 162 163 164
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.

165 166 167 168 169 170 171 172 173 174 175
## 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,
176
[configure a scheduled pipeline](../../../ci/pipelines/schedules.md) to run a
177 178 179 180 181
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.

182 183 184 185 186 187 188 189
CAUTION: **Warning:**
Running Dependency Scanning from a scheduled pipeline might result in false negatives if your
project doesn't have a lock file and isn't configured for Continuous Delivery. A lock file is a file
that lists all transient dependencies and keeps track of their exact versions. The false negative
can occur because the dependency version resolved during the scan might differ from the ones
resolved when your project was built and released, in a previous pipeline. Java projects can't have
lock files. Python projects can have lock files, but GitLab Secure tools don't support them.

190 191 192
## Security scans using Auto DevOps

When using [Auto DevOps](../../../topics/autodevops/index.md), use
193
[special environment variables](../../../topics/autodevops/customize.md#environment-variables)
194
to configure daily security scans.
195

196 197
## Vulnerability list

198 199
Each dashboard's vulnerability list contains vulnerabilities from the latest scans that were merged
into the default branch.
200 201 202 203 204 205 206 207 208 209
Click any vulnerability in the table to see more information on that vulnerability. To create an
issue associated with the vulnerability, click the **Create Issue** button.

![Create an issue for the vulnerability](img/standalone_vulnerability_page_v13_1.png)

Once you create the issue, the vulnerability list contains a link to the issue and an icon whose
color indicates the issue's status (green for open issues, blue for closed issues).

![Display attached issues](img/vulnerability_list_table_v13_1.png)

210 211 212 213 214 215 216 217 218 219 220
<!-- ## 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. -->