14 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/#designated-technical-writers |
GitLab Security Dashboard, Security Center, and Vulnerability Reports (ULTIMATE)
GitLab provides a comprehensive set of features for viewing and managing vulnerabilities:
- Security dashboards: An overview of the security status in your instance, groups, and projects.
- Vulnerability reports: Detailed lists of all vulnerabilities for the instance, group, project, or pipeline. This is where you triage and manage vulnerabilities.
- Security Center: A dedicated area for vulnerability management at the instance level. This includes a security dashboard, vulnerability report, and settings.
You can also drill down into a vulnerability and get extra information on the Vulnerability Page. This view includes the project it comes from, any related file(s), and metadata that helps you analyze the risk it poses. You can also confirm, dismiss, or resolve a vulnerability, create an issue for it, and in some cases, generate a merge request to fix the vulnerability.
To benefit from these features, you must first configure one of the security scanners.
Supported reports
The vulnerability report displays vulnerabilities detected by scanners such as:
- Container Scanning
- Dynamic Application Security Testing
- Dependency Scanning
- Static Application Security Testing
- And others!
Requirements
To use the security dashboards and vulnerability reports:
- At least one project inside a group must be configured with at least one of the supported reports.
- The configured jobs must use the new
reportssyntax. - GitLab Runner 11.5 or newer must be used. If you're using the shared runners on GitLab.com, this is already the case.
Pipeline Security
Introduced in GitLab Ultimate 12.3.
At the pipeline level, the Security section displays the vulnerabilities present in the branch of the project the pipeline ran against.
Visit the page for any pipeline that ran any of the supported reports. To view the pipeline's security findings, select the Security tab when viewing the pipeline.
A pipeline consists of multiple jobs, including SAST and DAST scanning. If any job fails to finish for any reason, 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.
Project Security Dashboard
Introduced in GitLab Ultimate 13.6.
At the project level, the Security Dashboard displays a chart with the number of vulnerabilities over time. Access it by navigating to Security & Compliance > Security Dashboard. Currently, we display historical data up to 365 days.
Filter the historical data by clicking on the corresponding legend name. The image above, for example, shows only the graph for vulnerabilities with high severity.
Vulnerability Report
Introduced in GitLab Ultimate 11.1.
The vulnerabilities that exist in your project's default branch are accessed by navigating to Security & Compliance > Vulnerability Report. By default, the Vulnerability Report is filtered to display all detected and confirmed vulnerabilities.
The Vulnerability Report first displays the time at which the last pipeline completed on the project's default branch. There's also a link to view this in more detail. In the case of any pipeline failures, you will see the number of failures clearly indicated. The failure notification takes you directly to the Failed jobs tab of the pipeline page.
The Vulnerability Report next displays the total number of vulnerabilities by severity (for example, Critical, High, Medium, Low, Info, Unknown). Below this, a table shows each vulnerability's status, severity, and description. Clicking a vulnerability takes you to its Vulnerability Details page to view more information about that vulnerability.
You can filter the vulnerabilities by one or more of the following:
| Filter | Available Options |
|---|---|
| Status | Detected, Confirmed, Dismissed, Resolved |
| Severity | Critical, High, Medium, Low, Info, Unknown |
| Scanner | Available Scanners |
You can also dismiss vulnerabilities in the table:
- Select the checkbox for each vulnerability you want to dismiss.
- In the menu that appears, select the reason for dismissal and click Dismiss Selected.
Group Security Dashboard
Introduced in GitLab Ultimate 11.5.
The group Security Dashboard gives an overview of the vulnerabilities found in the default branches of the projects in a group and its subgroups. Access it by navigating to Security > Security Dashboard after selecting your group. By default, the Security Dashboard displays all detected and confirmed vulnerabilities. If you don't see the vulnerabilities over time graph, the likely cause is that you have not selected a group.
Note that the Security Dashboard only shows projects with security reports enabled in a group.
There is a timeline chart that shows how many open vulnerabilities your projects had at various points in time. You can display the vulnerability trends over a 30, 60, or 90-day time frame (the default is 90 days). Hover over the chart to get more details about the open vulnerabilities at a specific time. Aggregated data beyond 90 days can be accessed by querying our VulnerabilitiesCountByDay GraphQL API. This data is retained for 365 days.
Next to the timeline chart is a list of projects, grouped and sorted by the severity of the vulnerability found:
| Grade | Description | | F | One or more "critical" | | D | One or more "high" or "unknown" | | C | One or more "medium" | | B | One or more "low" | | A | Zero vulnerabilities |
Projects with no vulnerability tests configured will not appear in the list. Additionally, dismissed vulnerabilities are excluded.
Navigate to the group's vulnerability report to view the vulnerabilities found.
Instance Security Center
Introduced in GitLab Ultimate 13.4.
The Security Center is where you manage vulnerabilities for your instance. It displays the vulnerabilities present in the default branches of all the projects you configure. It includes the following:
- The group security dashboard's features.
- A vulnerability report.
- A dedicated settings area to configure which projects to display.
You can access the Instance Security Center from the menu bar at the top of the page. Under More, select Security.
The dashboard and vulnerability report are empty before you add projects.
Adding projects to the Security Center
To add projects to the Security Center:
- Click Settings in the left navigation bar or click the Add projects button.
- Search for and add one or more projects using the Search your projects field.
- Click the Add projects button.
After you add projects, the security dashboard and vulnerability report display the vulnerabilities found in those projects' default branches.
Export vulnerabilities
Introduced in GitLab Ultimate 12.10.
You can export all your vulnerabilities in CSV (comma separated values) format by clicking the {upload} Export button located at top right of the Security Dashboard. When the report is ready, the CSV report downloads to your local machine. The report contains all vulnerabilities for the projects defined in the 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.
The fields in the export include:
- Group Name
- Project Name
- Scanner Type
- Scanner Name
- Status
- Vulnerability
- Details
- Additional Info
- Severity
- CVE (Common Vulnerabilities and Exposures)
- CWE (Common Weakness Enumeration)
- Other Identifiers
Keeping the dashboards up to date
The Security Dashboard displays information from the results of the most recent security scan on the 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 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.
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.
Security scans using Auto DevOps
When using Auto DevOps, use special environment variables to configure daily security scans.
Vulnerability report
Each vulnerability report contains vulnerabilities from the latest scans that were merged into the default branch.
You can filter which vulnerabilities the vulnerability report displays by:
| Filter | Available Options |
|---|---|
| Status | Detected, Confirmed, Dismissed, Resolved |
| Severity | Critical, High, Medium, Low, Info, Unknown |
| Scanner | Available Scanners |
| Project | Projects configured in the Security Center settings |
Clicking any vulnerability in the table takes you to its Vulnerability Details page to see more information on that vulnerability. To create an issue associated with the vulnerability, click the Create Issue button.
Once you create the issue, the linked issue icon in the vulnerability list:
- Indicates that an issue has been created for that vulnerability.
- Shows a tooltip that contains a link to the issue.
Read more on how to interact with the vulnerabilities.