debian-mirror-gitlab/doc/user/application_security/vulnerabilities/index.md
2022-04-04 11:22:00 +05:30

6.8 KiB

stage group info
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

Vulnerability Pages (ULTIMATE)

Introduced in GitLab 13.0.

Each vulnerability in a project has a Vulnerability Page. This page contains details of the vulnerability. The details included vary according to the type of vulnerability. Details of each vulnerability include:

  • Description
  • When it was detected
  • Current status
  • Available actions
  • Linked issues
  • Actions log

In GitLab 14.3 and later, if the scanner determined the vulnerability to be a false positive, an alert message is included at the top of the vulnerability's page.

On the vulnerability's page, you can:

Vulnerability status values

A vulnerability's status can be one of the following:

Status Description
Detected The default state for a newly discovered vulnerability. Appears as "Needs triage" in the UI.
Confirmed A user has seen this vulnerability and confirmed it to be accurate.
Dismissed A user has seen this vulnerability and dismissed it because it is not accurate or otherwise not to be resolved.
Resolved The vulnerability has been fixed or is no longer present.

Dismissed vulnerabilities are ignored if detected in subsequent scans. Resolved vulnerabilities that are reintroduced and detected by subsequent scans have a new vulnerability record created. When an existing vulnerability is no longer detected in a project's default branch, you should change its status to Resolved. This ensures that if it is accidentally reintroduced in a future merge, it will be visible again as a new record. You can use the Activity filter to select all vulnerabilities that are no longer detected, and change their status.

Change vulnerability status

To change a vulnerability's status, select a new value from the Status dropdown then select Change status. Optionally, add a comment to the log entry at the bottom of the page.

Create an issue for a vulnerability

From a vulnerability's page you can create an issue to track all action taken to resolve or mitigate it.

You can create either:

Creating a Jira issue requires that Jira integration is enabled on the project. Note that when Jira integration is enabled, the GitLab issue feature is not available.

Create a GitLab issue for a vulnerability

To create a GitLab issue for a vulnerability:

  1. In GitLab, go to the vulnerability's page.
  2. Select Create issue.

An issue is created in the project, pre-populated with information from the vulnerability report. The issue is then opened so you can take further action.

Create a Jira issue for a vulnerability

Prerequisites:

  • Enable Jira integration. The Enable Jira issues creation from vulnerabilities option must be selected as part of the configuration.
  • Each user must have a personal Jira user account with permission to create issues in the target project.

To create a Jira issue for a vulnerability:

  1. Go to the vulnerability's page.
  2. Select Create Jira issue.
  3. If you're not already logged in to Jira, log in.

The Jira issue is created and opened in a new browser tab. The Summary and Description fields are pre-populated from the vulnerability's details.

Unlike GitLab issues, the status of whether a Jira issue is open or closed does not display in the GitLab user interface.

Linked issues

NOTE: If Jira issue support is enabled, GitLab issues are disabled so this feature is not available.

You can link one or more existing GitLab issues to a vulnerability. Adding a link helps track the issue that resolves or mitigates a vulnerability.

Issues linked to a vulnerability are shown in the Vulnerability Report and the vulnerability's page.

Be aware of the following conditions between a vulnerability and a linked issue:

  • The vulnerability page shows related issues, but the issue page doesn't show the vulnerability it's related to.
  • An issue can only be related to one vulnerability at a time.
  • Issues can be linked across groups and projects.

To link a vulnerability to existing issues:

  1. Go to the vulnerability's page.
  2. In the Linked issues section, select the plus icon ({plus}).
  3. For each issue to be linked, either:
    • Paste a link to the issue.
    • Enter the issue's ID (prefixed with a hash #).
  4. Select Add.

The selected issues are added to the Linked issues section, and the linked issues counter is updated.

Resolve a vulnerability

For some vulnerabilities a solution is already known. In those instances, a vulnerability's page includes a Resolve with merge request option.

To resolve a vulnerability, you can either:

The following scanners are supported:

Create merge request from vulnerability

Resolve a vulnerability with a merge request

To resolve the vulnerability with a merge request, go to the vulnerability's page and from the Resolve with merge request dropdown select Resolve with merge request.

A merge request is created which applies the patch required to resolve the vulnerability. Process the merge request according to your standard workflow.

Resolve a vulnerability manually

To manually apply the patch that GitLab generated for a vulnerability:

  1. Go to the vulnerability's page and from the Resolve with merge request dropdown select Download patch to resolve.
  2. Ensure your local project has the same commit checked out that was used to generate the patch.
  3. Run git apply remediation.patch.
  4. Verify and commit the changes to your branch.