2019-10-12 21:52:04 +05:30
---
2021-01-29 00:20:46 +05:30
stage: none
group: unassigned
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
2019-10-12 21:52:04 +05:30
type: reference, howto
---
2019-09-30 21:07:59 +05:30
# GitLab Secure **(ULTIMATE)**
2019-07-31 22:56:46 +05:30
2020-03-13 15:44:24 +05:30
GitLab can check your application for security vulnerabilities that may lead to unauthorized access,
data leaks, denial of services, and more. GitLab reports vulnerabilities in the merge request so you
can fix them before merging. The [Security Dashboard ](security_dashboard/index.md ) provides a
2020-04-22 19:07:51 +05:30
high-level view of vulnerabilities detected in your projects, pipeline, and groups. The [Threat Monitoring ](threat_monitoring/index.md )
page provides runtime security metrics for application environments. With the information provided,
you can immediately begin risk analysis and remediation.
2019-10-12 21:52:04 +05:30
2020-04-22 19:07:51 +05:30
< i class = "fa fa-youtube-play youtube" aria-hidden = "true" > < / i >
2019-10-12 21:52:04 +05:30
For an overview of application security with GitLab, see
[Security Deep Dive ](https://www.youtube.com/watch?v=k4vEJnGYy84 ).
2019-07-31 22:56:46 +05:30
2020-04-08 14:13:33 +05:30
## Quick start
2020-06-23 00:09:42 +05:30
Get started quickly with Dependency Scanning, License Scanning, Static Application Security
2021-01-29 00:20:46 +05:30
Testing (SAST), and Secret Detection by adding the following to your [`.gitlab-ci.yml` ](../../ci/yaml/README.md ):
2020-04-08 14:13:33 +05:30
```yaml
include:
2021-01-03 14:25:43 +05:30
- template: Security/Dependency-Scanning.gitlab-ci.yml
- template: Security/License-Scanning.gitlab-ci.yml
- template: Security/SAST.gitlab-ci.yml
- template: Security/Secret-Detection.gitlab-ci.yml
2020-04-08 14:13:33 +05:30
```
To add Dynamic Application Security Testing (DAST) scanning, add the following to your
`.gitlab-ci.yml` and replace `https://staging.example.com` with a staging server's web address:
```yaml
include:
2021-01-03 14:25:43 +05:30
- template: Security/DAST.gitlab-ci.yml
2020-04-08 14:13:33 +05:30
variables:
DAST_WEBSITE: https://staging.example.com
```
To ensure the DAST scanner runs *after* deploying the application to the staging server, review the [DAST full documentation ](dast/index.md ).
To add Container Scanning, follow the steps listed in the [Container Scanning documentation ](container_scanning/index.md#requirements ).
To further configure any of the other scanners, refer to each scanner's documentation.
2020-10-24 23:57:45 +05:30
### SAST configuration
You can set up and configure Static Application Security Testing
(SAST) for your project, without opening a text editor. For more details,
see [configure SAST in the UI ](sast/index.md#configure-sast-in-the-ui ).
2020-05-24 23:13:21 +05:30
### Override the default registry base address
By default, GitLab security scanners use `registry.gitlab.com/gitlab-org/security-products/analyzers` as the
base address for Docker images. You can override this globally by setting the variable
`SECURE_ANALYZERS_PREFIX` to another location. Note that this affects all scanners at once.
2019-07-31 22:56:46 +05:30
## Security scanning tools
2020-03-13 15:44:24 +05:30
GitLab uses the following tools to scan and report known vulnerabilities found in your project.
2019-07-31 22:56:46 +05:30
2019-09-30 21:07:59 +05:30
| Secure scanning tool | Description |
2019-07-31 22:56:46 +05:30
|:-----------------------------------------------------------------------------|:-----------------------------------------------------------------------|
2019-09-30 21:07:59 +05:30
| [Container Scanning ](container_scanning/index.md ) ** (ULTIMATE)** | Scan Docker containers for known vulnerabilities. |
2019-10-12 21:52:04 +05:30
| [Dependency List ](dependency_list/index.md ) ** (ULTIMATE)** | View your project's dependencies and their known vulnerabilities. |
2019-09-30 21:07:59 +05:30
| [Dependency Scanning ](dependency_scanning/index.md ) ** (ULTIMATE)** | Analyze your dependencies for known vulnerabilities. |
| [Dynamic Application Security Testing (DAST) ](dast/index.md ) ** (ULTIMATE)** | Analyze running web applications for known vulnerabilities. |
2021-01-29 00:20:46 +05:30
| [API fuzzing ](api_fuzzing/index.md ) ** (ULTIMATE)** | Find unknown bugs and vulnerabilities in web APIs with fuzzing. |
| [Secret Detection ](secret_detection/index.md ) | Analyze Git history for leaked secrets. |
2019-09-30 21:07:59 +05:30
| [Security Dashboard ](security_dashboard/index.md ) ** (ULTIMATE)** | View vulnerabilities in all your projects and groups. |
2020-10-24 23:57:45 +05:30
| [Static Application Security Testing (SAST) ](sast/index.md ) | Analyze source code for known vulnerabilities. |
| [Coverage fuzzing ](coverage_fuzzing/index.md ) ** (ULTIMATE)** | Find unknown bugs and vulnerabilities with coverage-guided fuzzing. |
2019-09-30 21:07:59 +05:30
2021-01-29 00:20:46 +05:30
### Use security scanning tools with Pipelines for Merge Requests
The security scanning tools can all be added to pipelines with [templates ](https://gitlab.com/gitlab-org/gitlab/-/tree/master/lib/gitlab/ci/templates/Security ).
See each tool for details on how to use include each template in your CI/CD configuration.
By default, the application security jobs are configured to run for branch pipelines only.
To use them with [pipelines for merge requests ](../../ci/merge_request_pipelines/index.md ),
you may need to override the default `rules:` configuration to add:
```yaml
rules:
- if: $CI_PIPELINE_SOURCE == "merge_request_event"
```
2020-06-23 00:09:42 +05:30
## Security Scanning with Auto DevOps
When [Auto DevOps ](../../topics/autodevops/ ) is enabled, all GitLab Security scanning tools will be configured using default settings.
2020-11-24 15:15:51 +05:30
- [Auto SAST ](../../topics/autodevops/stages.md#auto-sast )
- [Auto Secret Detection ](../../topics/autodevops/stages.md#auto-secret-detection )
- [Auto DAST ](../../topics/autodevops/stages.md#auto-dast )
- [Auto Dependency Scanning ](../../topics/autodevops/stages.md#auto-dependency-scanning )
- [Auto License Compliance ](../../topics/autodevops/stages.md#auto-license-compliance )
- [Auto Container Scanning ](../../topics/autodevops/stages.md#auto-container-scanning )
2020-06-23 00:09:42 +05:30
While you cannot directly customize Auto DevOps, you can [include the Auto DevOps template in your project's `.gitlab-ci.yml` file ](../../topics/autodevops/customize.md#customizing-gitlab-ciyml ).
2019-09-30 21:07:59 +05:30
## Maintenance and update of the vulnerabilities database
2020-03-13 15:44:24 +05:30
The scanning tools and vulnerabilities database are updated regularly.
2019-09-30 21:07:59 +05:30
| Secure scanning tool | Vulnerabilities database updates |
|:-------------------------------------------------------------|-------------------------------------------|
2020-06-23 00:09:42 +05:30
| [Container Scanning ](container_scanning/index.md ) | Uses `clair` . The latest `clair-db` version is used for each job by running the [`latest` Docker image tag ](https://gitlab.com/gitlab-org/gitlab/blob/438a0a56dc0882f22bdd82e700554525f552d91b/lib/gitlab/ci/templates/Security/Container-Scanning.gitlab-ci.yml#L37 ). The `clair-db` database [is updated daily according to the author ](https://github.com/arminc/clair-local-scan#clair-server-or-local ). |
2021-01-29 00:20:46 +05:30
| [Dependency Scanning ](dependency_scanning/index.md ) | Relies on `bundler-audit` (for Ruby gems), `retire.js` (for NPM packages), and `gemnasium` (GitLab's own tool for all libraries). Both `bundler-audit` and `retire.js` fetch their vulnerabilities data from GitHub repositories, so vulnerabilities added to `ruby-advisory-db` and `retire.js` are immediately available. The tools themselves are updated once per month if there's a new version. The [Gemnasium DB ](https://gitlab.com/gitlab-org/security-products/gemnasium-db ) is updated at least once a week. See our [current measurement of time from CVE being issued to our product being updated ](https://about.gitlab.com/handbook/engineering/development/performance-indicators/#cve-issue-to-update ). |
2020-03-13 15:44:24 +05:30
| [Dynamic Application Security Testing (DAST) ](dast/index.md ) | The scanning engine is updated on a periodic basis. See the [version of the underlying tool `zaproxy` ](https://gitlab.com/gitlab-org/security-products/dast/blob/master/Dockerfile#L1 ). The scanning rules are downloaded at scan runtime. |
| [Static Application Security Testing (SAST) ](sast/index.md ) | Relies exclusively on [the tools GitLab wraps ](sast/index.md#supported-languages-and-frameworks ). The underlying analyzers are updated at least once per month if a relevant update is available. The vulnerabilities database is updated by the upstream tools. |
Currently, you do not have to update GitLab to benefit from the latest vulnerabilities definitions.
2020-05-24 23:13:21 +05:30
The security tools are released as Docker images. The vendored job definitions that enable them use
major release tags according to [Semantic Versioning ](https://semver.org/ ). Each new release of the
tools overrides these tags.
The Docker images are updated to match the previous GitLab releases, so users automatically get the
2020-03-13 15:44:24 +05:30
latest versions of the scanning tools without having to do anything. There are some known issues
with this approach, however, and there is a
2020-06-23 00:09:42 +05:30
[plan to resolve them ](https://gitlab.com/gitlab-org/gitlab/-/issues/9725 ).
2019-07-31 22:56:46 +05:30
2021-01-29 00:20:46 +05:30
## Viewing security scan information in merge requests **(CORE)**
> - [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/4393) in GitLab Core 13.5.
> - Made [available in all tiers](https://gitlab.com/gitlab-org/gitlab/-/issues/273205) in 13.6.
> - It's [deployed behind a feature flag](../feature_flags.md), enabled by default.
> - It's enabled on GitLab.com.
> - It can be enabled or disabled for a single project.
> - It's recommended for production use.
> - For GitLab self-managed instances, GitLab administrators can opt to [disable it](#enable-or-disable-the-basic-security-widget). **(CORE ONLY)**
CAUTION: **Warning:**
This feature might not be available to you. Check the **version history** note above for details.
Merge requests which have run security scans let you know that the generated
reports are available to download.
2019-07-31 22:56:46 +05:30
## Interacting with the vulnerabilities
2019-12-21 20:55:43 +05:30
> Introduced in [GitLab Ultimate](https://about.gitlab.com/pricing/) 10.8.
2019-07-31 22:56:46 +05:30
Each security vulnerability in the merge request report or the
2020-03-13 15:44:24 +05:30
[Security Dashboard ](security_dashboard/index.md ) is actionable. Click an entry to view detailed
information with several options:
- [Dismiss vulnerability ](#dismissing-a-vulnerability ): Dismissing a vulnerability styles it in
strikethrough.
- [Create issue ](#creating-an-issue-for-a-vulnerability ): Create a new issue with the title and
2020-06-23 00:09:42 +05:30
description pre-populated with information from the vulnerability report. By default, such issues
2020-03-13 15:44:24 +05:30
are [confidential ](../project/issues/confidential_issues.md ).
2021-01-29 00:20:46 +05:30
- [Automatic Remediation ](#automatic-remediation-for-vulnerabilities ): For some vulnerabilities,
2019-07-31 22:56:46 +05:30
a solution is provided for how to fix the vulnerability.
2020-11-24 15:15:51 +05:30
2019-07-31 22:56:46 +05:30
2020-07-28 23:09:34 +05:30
### View details of a DAST vulnerability
2020-10-24 23:57:45 +05:30
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/36332) in [GitLab Ultimate](https://about.gitlab.com/pricing/) 13.1.
2020-07-28 23:09:34 +05:30
Vulnerabilities detected by DAST occur in the live web application. Rectification of these types of
vulnerabilities requires specific information. DAST provides the information required to
investigate and rectify the underlying cause.
To view details of DAST vulnerabilities:
1. To see all vulnerabilities detected:
- In a project, go to the project's ** {shield}** **Security & Compliance** page.
- Only in a merge request, go the merge request's **Security** tab.
1. Click on the vulnerability's description. The following details are provided:
2021-01-29 00:20:46 +05:30
| Field | Description |
|:-----------------|:------------------------------------------------------------------ |
| Description | Description of the vulnerability. |
| Project | Namespace and project in which the vulnerability was detected. |
| Method | HTTP method used to detect the vulnerability. |
| URL | URL at which the vulnerability was detected. |
| Request Headers | Headers of the request. |
| Response Status | Response status received from the application. |
| Response Headers | Headers of the response received from the application. |
2020-07-28 23:09:34 +05:30
| Evidence | Evidence of the data found that verified the vulnerability. Often a snippet of the request or response, this can be used to help verify that the finding is a vulnerability. |
2021-01-29 00:20:46 +05:30
| Identifiers | Identifiers of the vulnerability. |
| Severity | Severity of the vulnerability. |
| Scanner Type | Type of vulnerability report. |
| Links | Links to further details of the detected vulnerability. |
| Solution | Details of a recommended solution to the vulnerability (optional). |
2020-07-28 23:09:34 +05:30
#### Hide sensitive information in headers
HTTP request and response headers may contain sensitive information, including cookies and
authorization credentials. By default, content of specific headers are masked in DAST vulnerability
reports. You can specify the list of all headers to be masked. For details, see
[Hide sensitive information ](dast/index.md#hide-sensitive-information ).
2019-07-31 22:56:46 +05:30
### Dismissing a vulnerability
2020-11-24 15:15:51 +05:30
To dismiss a vulnerability, you must set its status to Dismissed. This dismisses the vulnerability
for the entire project. Follow these steps to do so:
2020-05-24 23:13:21 +05:30
1. Select the vulnerability in the Security Dashboard.
1. Select **Dismissed** from the **Status** selector menu at the top-right.
You can undo this action by selecting a different status from the same menu.
2019-07-31 22:56:46 +05:30
2019-09-04 21:01:54 +05:30
#### Adding a dismissal reason
2019-12-21 20:55:43 +05:30
> Introduced in [GitLab Ultimate](https://about.gitlab.com/pricing/) 12.0.
2019-09-04 21:01:54 +05:30
2020-05-24 23:13:21 +05:30
When dismissing a vulnerability, it's often helpful to provide a reason for doing so. Upon setting a
vulnerability's status to Dismissed, a text box appears for you to add a comment with your
dismissal. Once added, you can edit or delete it. This allows you to add and update context for a
vulnerability as you learn more over time.
2019-09-04 21:01:54 +05:30
2020-11-24 15:15:51 +05:30
2019-09-04 21:01:54 +05:30
2020-04-08 14:13:33 +05:30
#### Dismissing multiple vulnerabilities
> Introduced in [GitLab Ultimate](https://about.gitlab.com/pricing/) 12.9.
You can dismiss multiple vulnerabilities at once, providing an optional reason.
Selecting the checkboxes on the side of each vulnerability in the list will select that individual vulnerability.
Alternatively, you can select all the vulnerabilities in the list by selecting the checkbox in the table header.
Deselecting the checkbox in the header will deselect all the vulnerabilities in the list.
Once you have selected some vulnerabilities, a menu appears at the top of the table that allows you to select a dismissal reason.
Pressing the "Dismiss Selected" button will dismiss all the selected vulnerabilities at once, with the reason you chose.
2021-01-29 00:20:46 +05:30
### Creating an issue for a vulnerability
You can create an issue for a vulnerability by visiting the vulnerability's page and clicking
**Create issue**, which you can find in the **Related issues** section.
This creates a [confidential issue ](../project/issues/confidential_issues.md ) in the project the
vulnerability came from, and pre-populates it with some useful information taken from the vulnerability
report. Once the issue is created, you are redirected to it so you can edit, assign, or comment on
it.
Upon returning to the group security dashboard, the vulnerability now has an associated issue next
to the name.
### Automatic remediation for vulnerabilities
2019-07-31 22:56:46 +05:30
2020-06-23 00:09:42 +05:30
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/5656) in [GitLab Ultimate](https://about.gitlab.com/pricing/) 11.7.
2019-07-31 22:56:46 +05:30
Some vulnerabilities can be fixed by applying the solution that GitLab
2021-01-29 00:20:46 +05:30
automatically generates. Although the feature name is Automatic Remediation, this feature is also commonly called Auto-Remediation, Auto Remediation, or Suggested Solutions. The following scanners are supported:
2019-12-04 20:38:33 +05:30
- [Dependency Scanning ](dependency_scanning/index.md ):
2020-03-13 15:44:24 +05:30
Automatic Patch creation is only available for Node.js projects managed with
2019-12-04 20:38:33 +05:30
`yarn` .
2020-03-13 15:44:24 +05:30
- [Container Scanning ](container_scanning/index.md )
2019-07-31 22:56:46 +05:30
2021-01-29 00:20:46 +05:30
When an automatic solution is available, the button in the header shows **Resolve with merge request** :
Selecting the button creates a merge request with the solution.
2019-07-31 22:56:46 +05:30
#### Manually applying the suggested patch
2021-01-29 00:20:46 +05:30
To manually apply the patch that GitLab generated for a vulnerability:
1. Select the **Resolve with merge request** dropdown, then select **Download patch to resolve** :
2019-07-31 22:56:46 +05:30
2019-10-12 21:52:04 +05:30
1. Ensure your local project has the same commit checked out that was used to generate the patch.
1. Run `git apply remediation.patch` .
1. Verify and commit the changes to your branch.
2019-07-31 22:56:46 +05:30
#### Creating a merge request from a vulnerability
2020-06-23 00:09:42 +05:30
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/9224) in [GitLab Ultimate](https://about.gitlab.com/pricing/) 11.9.
2019-07-31 22:56:46 +05:30
2020-03-13 15:44:24 +05:30
In certain cases, GitLab allows you to create a merge request that automatically remediates the
vulnerability. Any vulnerability that has a
2021-01-29 00:20:46 +05:30
[solution ](#automatic-remediation-for-vulnerabilities ) can have a merge
2019-12-04 20:38:33 +05:30
request created to automatically solve the issue.
2019-07-31 22:56:46 +05:30
2020-11-24 15:15:51 +05:30
If this action is available, the vulnerability page or modal contains a **Create merge request** button.
2020-03-13 15:44:24 +05:30
Click this button to create a merge request to apply the solution onto the source branch.
2019-07-31 22:56:46 +05:30
2020-11-24 15:15:51 +05:30
2020-10-24 23:57:45 +05:30
### Managing related issues for a vulnerability
Issues can be linked to a vulnerability using the related issues block on the vulnerability page.
The relationship is uni-directional. 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.
#### Adding a related issue
You can link an issue by clicking the ** {plus}** button in the **Related Issues** block.
A text box appears that lets you type an issue number or paste an issue link. You can enter multiple
issues at once. Pressing the space bar after each issue number or link converts them to tags that
you can remove by clicking the ** {close}** icon to the tag's right. Typing `#` followed by a number
shows an autocomplete menu. Click an issue in the menu to add it as a tag. When you're finished
entering issues, click the **Add** button to link the issues to the vulnerability. Alternatively,
click **Cancel** to exit without linking any issues.
### Removing a related issue
Click the ** {close}** icon to right of an issue to remove it as a related issue. Note that this only
removes it as a related issue of the vulnerability; it doesn't modify or remove the issue itself.
You can link it to the vulnerability again if desired.
2020-03-13 15:44:24 +05:30
## Security approvals in merge requests
2019-10-12 21:52:04 +05:30
2020-06-23 00:09:42 +05:30
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/9928) in [GitLab Ultimate](https://about.gitlab.com/pricing/) 12.2.
2019-10-12 21:52:04 +05:30
2020-03-13 15:44:24 +05:30
Merge Request Approvals can be configured to require approval from a member of your
security team when a merge request would introduce one of the following security issues:
- A security vulnerability
- A software license compliance violation
2019-10-12 21:52:04 +05:30
2020-05-24 23:13:21 +05:30
The security vulnerability threshold is defined as `high` , `critical` , or `unknown` severity. The
`Vulnerability-Check` approver group must approve merge requests that contain vulnerabilities.
When GitLab can assess vulnerability severity, the rating can be one of the following:
- `unknown`
- `low`
- `medium`
- `high`
- `critical`
The rating `unknown` indicates that the underlying scanner doesn't contain or provide a severity
rating.
2019-10-12 21:52:04 +05:30
### Enabling Security Approvals within a project
2020-11-24 15:15:51 +05:30
To enable the `Vulnerability-Check` or `License-Check` Security Approvals, a [project approval rule ](../project/merge_requests/merge_request_approvals.md#adding--editing-a-default-approval-rule )
must be created. A [security scanner job ](#security-scanning-tools ) must be enabled for
`Vulnerability-Check` , and a [license scanning ](../compliance/license_compliance/index.md#configuration )
job must be enabled for `License-Check` . When the proper jobs aren't configured, the following
appears:
2021-01-29 00:20:46 +05:30
If at least one security scanner is enabled, you can enable the `Vulnerability-Check` approval rule. If a license scanning job is enabled, you can enable the `License-Check` rule.
2020-11-24 15:15:51 +05:30
For this approval group, you must set the number of approvals required to greater than zero. You
must have Maintainer or Owner [permissions ](../permissions.md#project-members-permissions )
to manage approval rules.
Follow these steps to enable `Vulnerability-Check` :
2020-06-23 00:09:42 +05:30
2020-10-24 23:57:45 +05:30
1. Navigate to your project's **Settings > General** and expand **Merge request approvals** .
2020-11-24 15:15:51 +05:30
1. Click **Enable** , or **Edit** .
1. Add or change the **Rule name** to `Vulnerability-Check` (case sensitive).
2020-06-23 00:09:42 +05:30
2020-11-24 15:15:51 +05:30
2019-10-12 21:52:04 +05:30
2020-03-13 15:44:24 +05:30
Once this group is added to your project, the approval rule is enabled for all merge requests.
2019-10-12 21:52:04 +05:30
2020-03-13 15:44:24 +05:30
Any code changes cause the approvals required to reset.
2019-10-12 21:52:04 +05:30
2020-10-24 23:57:45 +05:30
An approval is required when the latest security report in a merge request:
2019-10-12 21:52:04 +05:30
2020-10-24 23:57:45 +05:30
- Contains a vulnerability of `high` , `critical` , or `unknown` severity that is not present in the
target branch. Note that approval is still required for dismissed vulnerabilities.
2019-10-12 21:52:04 +05:30
- Is not generated during pipeline execution.
2020-10-24 23:57:45 +05:30
An approval is optional when the security report:
2019-10-12 21:52:04 +05:30
2020-10-24 23:57:45 +05:30
- Contains no new vulnerabilities when compared to the target branch.
2019-10-12 21:52:04 +05:30
- Contains only new vulnerabilities of `low` or `medium` severity.
2020-11-24 15:15:51 +05:30
### Enabling License Approvals within a project
2020-04-08 14:13:33 +05:30
2020-06-23 00:09:42 +05:30
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/13067) in [GitLab Ultimate](https://about.gitlab.com/pricing/) 12.3.
2019-12-04 20:38:33 +05:30
2020-11-24 15:15:51 +05:30
`License-Check` is a [security approval rule ](#enabling-security-approvals-within-a-project )
you can enable to allow an individual or group to approve a merge request that contains a `denied`
license. For instructions on enabling this rule, see
[Enabling license approvals within a project ](../compliance/license_compliance/index.md#enabling-license-approvals-within-a-project ).
2019-12-04 20:38:33 +05:30
2020-04-08 14:13:33 +05:30
## Working in an offline environment
It is possible to run most of the GitLab security scanners when not
connected to the internet, in what is sometimes known as an offline,
limited connectivity, Local Area Network (LAN), Intranet, or "air-gap"
environment.
Read how to [operate the Secure scanners in an offline environment ](offline_deployments/index.md ).
2020-04-22 19:07:51 +05:30
## Using private Maven repos
If you have a private Apache Maven repository that requires login credentials,
you can use the `MAVEN_CLI_OPTS` environment variable
to pass a username and password. You can set it under your project's settings
so that your credentials aren't exposed in `.gitlab-ci.yml` .
If the username is `myuser` and the password is `verysecret` then you would
2020-05-24 23:13:21 +05:30
[set the following variable ](../../ci/variables/README.md#create-a-custom-variable-in-the-ui )
2020-04-22 19:07:51 +05:30
under your project's settings:
| Type | Key | Value |
| ---- | --- | ----- |
| Variable | `MAVEN_CLI_OPTS` | `--settings mysettings.xml -Drepository.password=verysecret -Drepository.user=myuser` |
```xml
<!-- mysettings.xml -->
< settings >
...
< servers >
< server >
< id > private_server< / id >
< username > ${private.username}< / username >
< password > ${private.password}< / password >
< / server >
< / servers >
< / settings >
```
2020-04-08 14:13:33 +05:30
## Outdated security reports
2020-06-23 00:09:42 +05:30
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/4913) in GitLab 12.7.
2020-04-08 14:13:33 +05:30
When a security report generated for a merge request becomes outdated, the merge request shows a warning
message in the security widget and prompts you to take an appropriate action.
This can happen in two scenarios:
1. Your [source branch is behind the target branch ](#source-branch-is-behind-the-target-branch ).
1. The [target branch security report is out of date ](#target-branch-security-report-is-out-of-date ).
### Source branch is behind the target branch
This means the most recent common ancestor commit between the target branch and the source branch is
not the most recent commit on the target branch. This is by far the most common situation.
In this case you must rebase or merge to incorporate the changes from the target branch.
### Target branch security report is out of date
This can happen for many reasons, including failed jobs or new advisories. When the merge request shows that a
security report is out of date, you must run a new pipeline on the target branch.
You can do it quickly by following the hyperlink given to run a new pipeline.
2019-12-26 22:10:19 +05:30
## Troubleshooting
2019-10-12 21:52:04 +05:30
2019-12-26 22:10:19 +05:30
### Getting error message `sast job: stage parameter should be [some stage name here]`
2019-10-12 21:52:04 +05:30
2020-05-24 23:13:21 +05:30
When [including ](../../ci/yaml/README.md#includetemplate ) a `.gitlab-ci.yml` template
like [`SAST.gitlab-ci.yml` ](https://gitlab.com/gitlab-org/gitlab/blob/master/lib/gitlab/ci/templates/Security/SAST.gitlab-ci.yml ),
2020-03-13 15:44:24 +05:30
the following error may occur, depending on your GitLab CI/CD configuration:
2019-12-26 22:10:19 +05:30
2020-03-13 15:44:24 +05:30
```plaintext
2019-12-26 22:10:19 +05:30
Found errors in your .gitlab-ci.yml:
* sast job: stage parameter should be unit-tests
```
2020-03-13 15:44:24 +05:30
This error appears when the included job's stage (named `test` ) isn't declared in `.gitlab-ci.yml` .
2019-12-26 22:10:19 +05:30
To fix this issue, you can either:
- Add a `test` stage in your `.gitlab-ci.yml` .
2020-05-24 23:13:21 +05:30
- Change the default stage of the included security jobs. For example, with SpotBugs (SAST):
2019-12-26 22:10:19 +05:30
```yaml
include:
2021-01-03 14:25:43 +05:30
template: Security/SAST.gitlab-ci.yml
2019-12-26 22:10:19 +05:30
2020-05-24 23:13:21 +05:30
spotbugs-sast:
2019-12-26 22:10:19 +05:30
stage: unit-tests
```
2020-05-24 23:13:21 +05:30
[Learn more on overriding SAST jobs ](sast/index.md#overriding-sast-jobs ).
2020-03-13 15:44:24 +05:30
All the security scanning tools define their stage, so this error can occur with all of them.
2020-05-24 23:13:21 +05:30
2021-01-03 14:25:43 +05:30
### Getting warning messages `… report.json: no matching files`
This is often followed by the [error `No files to upload` ](../../ci/pipelines/job_artifacts.md#error-message-no-files-to-upload ),
and preceded by other errors or warnings that indicate why the JSON report wasn't generated. Please
check the entire job log for such messages. If you don't find these messages, retry the failed job
after setting `SECURE_LOG_LEVEL: "debug"` as a
[custom environment variable ](../../ci/variables/README.md#custom-environment-variables ).
This provides useful information to investigate further.
2020-05-24 23:13:21 +05:30
### Getting error message `sast job: config key may not be used with 'rules': only/except`
When [including ](../../ci/yaml/README.md#includetemplate ) a `.gitlab-ci.yml` template
like [`SAST.gitlab-ci.yml` ](https://gitlab.com/gitlab-org/gitlab/blob/master/lib/gitlab/ci/templates/Security/SAST.gitlab-ci.yml ),
the following error may occur, depending on your GitLab CI/CD configuration:
```plaintext
Found errors in your .gitlab-ci.yml:
jobs:sast config key may not be used with `rules` : only/except
```
This error appears when the included job's `rules` configuration has been [overridden ](sast/index.md#overriding-sast-jobs )
with [the deprecated `only` or `except` syntax. ](../../ci/yaml/README.md#onlyexcept-basic )
To fix this issue, you must either:
- [Transition your `only/except` syntax to `rules` ](#transitioning-your-onlyexcept-syntax-to-rules ).
- (Temporarily) [Pin your templates to the deprecated versions ](#pin-your-templates-to-the-deprecated-versions )
[Learn more on overriding SAST jobs ](sast/index.md#overriding-sast-jobs ).
#### Transitioning your `only/except` syntax to `rules`
When overriding the template to control job execution, previous instances of
[`only` or `except` ](../../ci/yaml/README.md#onlyexcept-basic ) are no longer compatible
and must be transitioned to [the `rules` syntax ](../../ci/yaml/README.md#rules ).
If your override is aimed at limiting jobs to only run on `master` , the previous syntax
would look similar to:
```yaml
include:
2021-01-03 14:25:43 +05:30
- template: Security/SAST.gitlab-ci.yml
2020-05-24 23:13:21 +05:30
# Ensure that the scanning is only executed on master or merge requests
spotbugs-sast:
only:
refs:
- master
- merge_requests
```
To transition the above configuration to the new `rules` syntax, the override
would be written as follows:
```yaml
include:
2021-01-03 14:25:43 +05:30
- template: Security/SAST.gitlab-ci.yml
2020-05-24 23:13:21 +05:30
# Ensure that the scanning is only executed on master or merge requests
spotbugs-sast:
rules:
- if: $CI_COMMIT_BRANCH == "master"
- if: $CI_MERGE_REQUEST_ID
```
If your override is aimed at limiting jobs to only run on branches, not tags,
it would look similar to:
```yaml
include:
2021-01-03 14:25:43 +05:30
- template: Security/SAST.gitlab-ci.yml
2020-05-24 23:13:21 +05:30
# Ensure that the scanning is not executed on tags
spotbugs-sast:
except:
- tags
```
To transition to the new `rules` syntax, the override would be rewritten as:
```yaml
include:
2021-01-03 14:25:43 +05:30
- template: Security/SAST.gitlab-ci.yml
2020-05-24 23:13:21 +05:30
# Ensure that the scanning is not executed on tags
spotbugs-sast:
rules:
- if: $CI_COMMIT_TAG == null
```
[Learn more on the usage of `rules` ](../../ci/yaml/README.md#rules ).
#### Pin your templates to the deprecated versions
To ensure the latest support, we **strongly** recommend that you migrate to [`rules` ](../../ci/yaml/README.md#rules ).
If you're unable to immediately update your CI configuration, there are several workarounds that
involve pinning to the previous template versions, for example:
```yaml
include:
remote: 'https://gitlab.com/gitlab-org/gitlab/-/raw/12-10-stable-ee/lib/gitlab/ci/templates/Security/SAST.gitlab-ci.yml'
```
Additionally, we provide a dedicated project containing the versioned legacy templates.
This can be useful for offline setups or anyone wishing to use [Auto DevOps ](../../topics/autodevops/index.md ).
Instructions are available in the [legacy template project ](https://gitlab.com/gitlab-org/auto-devops-v12-10 ).
2021-01-29 00:20:46 +05:30
#### Vulnerabilities are found, but the job succeeds. How can I have a pipeline fail instead?
This is the current default behavior, because the job's status indicates success or failure of the analyzer itself.
Analyzer results are displayed in the [job logs ](../../ci/jobs/index.md#expand-and-collapse-job-log-sections ),
[Merge Request widget ](sast/index.md )
or [Security Dashboard ](security_dashboard/index.md ).
There is [an open issue ](https://gitlab.com/gitlab-org/gitlab/-/issues/235772 ) in which changes to this behavior are being discussed.
### Enable or disable the basic security widget **(CORE ONLY)**
The basic security widget is under development but ready for production use.
It is deployed behind a feature flag that is **enabled by default** .
[GitLab administrators with access to the GitLab Rails console ](../feature_flags.md )
can opt to disable it.
To enable it:
```ruby
# For the instance
Feature.enable(:core_security_mr_widget)
# For a single project
Feature.enable(:core_security_mr_widget, Project.find(< project id > ))
```
To disable it:
```ruby
# For the instance
Feature.disable(:core_security_mr_widget)
# For a single project
Feature.disable(:core_security_mr_widget, Project.find(< project id > ))
```
