9.2 KiB
| type | stage | group | info |
|---|---|---|---|
| reference, howto | Secure | Threat Insights | To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments |
GitLab Security Dashboards and Security Center (ULTIMATE)
You can use Security Dashboards to view details about vulnerabilities detected by security scanners. These details are shown in pipelines, projects, and groups.
To use the Security Dashboards, you must:
- Configure at least one security scanner in a project.
- Configure jobs to use the
reportssyntax. - Use GitLab Runner 11.5 or later. If you use the shared runners on GitLab.com, you are using the correct version.
When Security Dashboards are updated
The Security Dashboards show results of the most recent security scan on the default branch. Security scans run only when the default branch updates, so information on the Security Dashboard might not reflect newly-discovered vulnerabilities.
To run a daily security scan, configure a scheduled pipeline.
Reduce false negatives in dependency scans
WARNING: False negatives occur when you resolve dependency versions during a scan, which differ from those resolved when your project built and released in a previous pipeline.
To reduce false negatives in dependency scans in scheduled pipelines, ensure you:
- Include a lock file in your project. A lock file lists all transient dependencies and tracks their versions.
- Java projects can't have lock files.
- Python projects can have lock files, but GitLab Secure tools don't support them.
- Configure your project for Continuous Delivery.
View vulnerabilities in a pipeline
Introduced in GitLab 12.3.
To view vulnerabilities in a pipeline:
- On the top bar, select Menu > Projects and find your project.
- On the left sidebar, select CI/CD > Pipelines.
- From the list, select the pipeline you want to check for vulnerabilities.
- Select the Security tab.
Scan details shows vulnerabilities introduced by the merge request, in addition to existing vulnerabilities from the latest successful pipeline in your project's default branch.
A pipeline consists of multiple jobs, such as SAST and DAST scans. If a job fails to finish, the security dashboard doesn't show SAST scanner output. For example, if the SAST job finishes but the DAST job fails, the security dashboard doesn't show SAST results. On failure, the analyzer outputs an exit code.
View total number of vulnerabilities per scan
To view the total number of vulnerabilities per scan:
- On the top bar, select Menu > Projects and find your project.
- On the left sidebar, select CI/CD > Pipelines.
- Select the Status of a branch.
- Select the Security tab.
Scan details shows vulnerabilities introduced by the merge request, in addition to existing vulnerabilities from the latest successful pipeline in your project's default branch.
Download security scan outputs
- Introduced in GitLab 13.10.
- Improved in GitLab 14.2.
Depending on the type of security scanner, you can download:
- A JSON artifact that contains the security scanner report.
- A CSV file that contains URLs and endpoints scanned by the security scanner.
To download a security scan output:
- On the top bar, select Menu > Projects and find your project.
- On the left sidebar, select CI/CD > Pipelines.
- Select the Status of a branch.
- Select the Security tab.
- In Scan details, select Download results:
- To download a JSON file, select the JSON artifact.
- To download a CSV file, select Download scanned resources.
View vulnerabilities over time for a project
- Introduced in GitLab 13.6.
- Introduced in GitLab 13.10, options to zoom in on a date range, and download the vulnerabilities chart.
- Introduced in GitLab 13.11, date range slider to visualize data between given dates.
The project Security Dashboard shows the total number of vulnerabilities over time, with up to 365 days of historical data. Data refreshes daily at 01:15 UTC. It shows statistics for all vulnerabilities.
To view total number of vulnerabilities over time:
- On the top bar, select Menu > Projects and find your project.
- On the left sidebar, select Security & Compliance > Security Dashboard.
- Filter and search for what you need.
- To filter the chart by severity, select the legend name.
- To view a specific time frame, use the time range handles ({scroll-handle}).
- To view a specific area of the chart, select the left-most icon ({marquee-selection}) and drag across the chart.
- To reset to the original range, select Remove Selection ({redo}).
Download the vulnerabilities chart
To download an SVG image of the vulnerabilities chart:
- On the top bar, select Menu > Projects and find your project.
- On the left sidebar, select Security & Compliance > Security dashboard.
- Select Save chart as an image ({download}).
View vulnerabilities over time for a group
The group Security Dashboard gives an overview of vulnerabilities found in the default branches of projects in a group and its subgroups.
To view vulnerabilities over time for a group:
- On the top bar, select Menu > Groups and select a group.
- Select Security > Security Dashboard.
- Hover over the chart to get more details about vulnerabilities.
- You can display the vulnerability trends over a 30, 60, or 90-day time frame (the default is 90 days).
- To view aggregated data beyond a 90-day time frame, use the VulnerabilitiesCountByDay GraphQL API. GitLab retains the data for 365 days.
View project security status for a group
Use the group Security Dashboard to view the security status of projects. The security status is based on the number of detected vulnerabilities.
To view project security status for a group:
- On the top bar, select Menu > Groups and select a group.
- Select Security > Security Dashboard.
Projects are graded by vulnerability severity. Dismissed vulnerabilities are excluded.
To view vulnerabilities, go to the group's vulnerability report.
Project vulnerability grades
| Grade | Description |
|---|---|
| F | One or more critical vulnerabilities |
| D | One or more high or unknown vulnerabilities |
| C | One or more medium vulnerabilities |
| B | One or more low vulnerabilities |
| A | Zero vulnerabilities |
Security Center
Introduced in GitLab 13.4.
The Security Center is a personal space where you view vulnerabilities across all your projects. It shows the vulnerabilities present in the default branches of the projects.
The Security Center includes:
- The group Security Dashboard.
- A vulnerability report.
- A settings area to configure which projects to display.
View the Security Center
To view the Security Center, on the top bar, select Menu > Security.
Add projects to the Security Center
To add projects to the Security Center:
- On the top bar, select Menu > Security.
- On the left sidebar, select Settings, or select Add projects.
- Use the Search your projects text box to search for and select projects.
- Select Add projects.
After you add projects, the security dashboard and vulnerability report show the vulnerabilities found in those projects' default branches.