debian-mirror-gitlab/doc/user/application_security/dependency_scanning/index.md

518 lines
29 KiB
Markdown
Raw Normal View History

2019-10-12 21:52:04 +05:30
---
type: reference, howto
2020-06-23 00:09:42 +05:30
stage: Secure
group: Composition Analysis
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
---
2019-09-30 21:07:59 +05:30
# Dependency Scanning **(ULTIMATE)**
2019-07-31 22:56:46 +05:30
2020-06-23 00:09:42 +05:30
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/5105) in [GitLab Ultimate](https://about.gitlab.com/pricing/) 10.7.
2019-12-04 20:38:33 +05:30
Dependency Scanning helps to automatically find security vulnerabilities in your dependencies
2020-05-24 23:13:21 +05:30
while you're developing and testing your applications, such as when your
2019-12-04 20:38:33 +05:30
application is using an external (open source) library which is known to be vulnerable.
2019-07-31 22:56:46 +05:30
## Overview
2020-05-24 23:13:21 +05:30
If you're using [GitLab CI/CD](../../../ci/README.md), you can analyze your dependencies for known
2019-07-31 22:56:46 +05:30
vulnerabilities using Dependency Scanning.
2020-04-08 14:13:33 +05:30
All dependencies are scanned, including the transitive dependencies (also known as nested dependencies).
2020-04-22 19:07:51 +05:30
You can take advantage of Dependency Scanning by either [including the Dependency Scanning template](#configuration)
2019-07-31 22:56:46 +05:30
in your existing `.gitlab-ci.yml` file or by implicitly using
2020-05-24 23:13:21 +05:30
the [Auto Dependency Scanning](../../../topics/autodevops/stages.md#auto-dependency-scanning-ultimate)
provided by [Auto DevOps](../../../topics/autodevops/index.md).
2019-07-31 22:56:46 +05:30
GitLab checks the Dependency Scanning report, compares the found vulnerabilities
2019-12-04 20:38:33 +05:30
between the source and target branches, and shows the information on the
2019-07-31 22:56:46 +05:30
merge request.
2020-05-24 23:13:21 +05:30
![Dependency Scanning Widget](img/dependency_scanning_v13_0.png)
2019-07-31 22:56:46 +05:30
2019-09-04 21:01:54 +05:30
The results are sorted by the severity of the vulnerability:
2019-07-31 22:56:46 +05:30
2019-09-04 21:01:54 +05:30
1. Critical
2019-07-31 22:56:46 +05:30
1. High
1. Medium
1. Low
1. Unknown
1. Everything else
## Requirements
2020-05-24 23:13:21 +05:30
To run Dependency Scanning jobs, by default, you need GitLab Runner with the
[`docker`](https://docs.gitlab.com/runner/executors/docker.html) or
[`kubernetes`](https://docs.gitlab.com/runner/install/kubernetes.html) executor.
If you're using the shared Runners on GitLab.com, this is enabled by default.
2019-07-31 22:56:46 +05:30
2019-12-04 20:38:33 +05:30
CAUTION: **Caution:**
2020-05-24 23:13:21 +05:30
If you use your own Runners, make sure your installed version of Docker
2020-04-22 19:07:51 +05:30
is **not** `19.03.0`. See [troubleshooting information](#error-response-from-daemon-error-processing-tar-file-docker-tar-relocation-error) for details.
2019-12-04 20:38:33 +05:30
2020-05-24 23:13:21 +05:30
Beginning with GitLab 13.0, Docker privileged mode is necessary only if you've [enabled Docker-in-Docker for Dependency Scanning](#enabling-docker-in-docker).
2019-12-26 22:10:19 +05:30
2019-07-31 22:56:46 +05:30
## Supported languages and package managers
2020-06-23 00:09:42 +05:30
GitLab relies on [`rules`](../../../ci/yaml/README.md#rules) to start relevant analyzers depending on the languages detected in the repository.
The current detection logic limits the maximum search depth to two levels. For example, the `gemnasium-dependency_scanning` job is enabled if a repository contains either a `Gemfile` or `api/Gemfile` file, but not if the only supported dependency file is `api/client/Gemfile`.
The following languages and dependency managers are supported:
| Language (package managers) | Supported files | Scan tool(s) |
|----------------------------- | --------------- | ------------ |
| Java ([Gradle](https://gradle.org/), [Maven](https://maven.apache.org/)) | `build.gradle`, `build.gradle.kts`, `pom.xml` | [Gemnasium](https://gitlab.com/gitlab-org/security-products/gemnasium) |
| JavaScript ([npm](https://www.npmjs.com/), [yarn](https://yarnpkg.com/en/)) | `package-lock.json`, `npm-shrinkwrap.json`, `yarn.lock` | [Gemnasium](https://gitlab.com/gitlab-org/security-products/gemnasium), [Retire.js](https://retirejs.github.io/retire.js) |
| Go ([Golang](https://golang.org/)) | `go.sum` | [Gemnasium](https://gitlab.com/gitlab-org/security-products/gemnasium) |
| PHP ([Composer](https://getcomposer.org/)) | `composer.lock` | [Gemnasium](https://gitlab.com/gitlab-org/security-products/gemnasium) |
| Python ([setuptools](https://setuptools.readthedocs.io/en/latest/), [pip](https://pip.pypa.io/en/stable/), [Pipenv](https://pipenv.pypa.io/en/latest/)) | `setup.py`, `requirements.txt`, `requirements.pip`, `requires.txt`, `Pipfile` | [Gemnasium](https://gitlab.com/gitlab-org/security-products/gemnasium) |
| Ruby ([Bundler](https://bundler.io/)) | `Gemfile.lock`, `gems.locked` | [Gemnasium](https://gitlab.com/gitlab-org/security-products/gemnasium), [bundler-audit](https://github.com/rubysec/bundler-audit) |
| Scala ([sbt](https://www.scala-sbt.org/)) | `build.sbt` | [Gemnasium](https://gitlab.com/gitlab-org/security-products/gemnasium) |
Plans are underway for supporting the following languages, dependency managers, and dependency files. For details, see the issue link for each.
| Language (package managers) | Supported files | Scan tool(s) | Issue |
|----------------------------- | --------------- | ------------ | ----- |
| Python ([Poetry](https://poetry.eustace.io/)) | `poetry.lock` | [Gemnasium](https://gitlab.com/gitlab-org/security-products/gemnasium) | [GitLab#7006](https://gitlab.com/gitlab-org/gitlab/issues/7006) |
| Python ([Pipenv](https://pipenv.pypa.io/en/latest/)) | `Pipfile.lock` | [Gemnasium](https://gitlab.com/gitlab-org/security-products/gemnasium) | [GitLab#11756](https://gitlab.com/gitlab-org/gitlab/-/issues/11756) |
2019-07-31 22:56:46 +05:30
2020-04-22 19:07:51 +05:30
## Contribute your scanner
The [Security Scanner Integration](../../../development/integrations/secure.md) documentation explains how to integrate other security scanners into GitLab.
2019-09-30 21:07:59 +05:30
## Configuration
2019-07-31 22:56:46 +05:30
2020-05-24 23:13:21 +05:30
To enable Dependency Scanning for GitLab 11.9 and later, you must
2019-09-30 21:07:59 +05:30
[include](../../../ci/yaml/README.md#includetemplate) the
2019-12-04 20:38:33 +05:30
[`Dependency-Scanning.gitlab-ci.yml` template](https://gitlab.com/gitlab-org/gitlab/blob/master/lib/gitlab/ci/templates/Security/Dependency-Scanning.gitlab-ci.yml)
2019-09-30 21:07:59 +05:30
that's provided as a part of your GitLab installation.
For GitLab versions earlier than 11.9, you can copy and use the job as defined
that template.
2019-07-31 22:56:46 +05:30
2019-09-30 21:07:59 +05:30
Add the following to your `.gitlab-ci.yml` file:
2019-07-31 22:56:46 +05:30
```yaml
include:
2020-03-13 15:44:24 +05:30
- template: Dependency-Scanning.gitlab-ci.yml
2019-07-31 22:56:46 +05:30
```
2020-05-24 23:13:21 +05:30
The included template will create Dependency Scanning jobs in your CI/CD
2019-07-31 22:56:46 +05:30
pipeline and scan your project's source code for possible vulnerabilities.
2019-09-30 21:07:59 +05:30
The results will be saved as a
2020-05-24 23:13:21 +05:30
[Dependency Scanning report artifact](../../../ci/pipelines/job_artifacts.md#artifactsreportsdependency_scanning-ultimate)
2019-07-31 22:56:46 +05:30
that you can later download and analyze. Due to implementation limitations, we
always take the latest Dependency Scanning artifact available.
2019-09-30 21:07:59 +05:30
### Customizing the Dependency Scanning settings
2019-07-31 22:56:46 +05:30
2019-09-30 21:07:59 +05:30
The Dependency Scanning settings can be changed through [environment variables](#available-variables) by using the
2019-07-31 22:56:46 +05:30
[`variables`](../../../ci/yaml/README.md#variables) parameter in `.gitlab-ci.yml`.
For example:
```yaml
include:
2020-03-13 15:44:24 +05:30
- template: Dependency-Scanning.gitlab-ci.yml
2019-07-31 22:56:46 +05:30
variables:
2019-12-26 22:10:19 +05:30
DS_PYTHON_VERSION: 2
2019-07-31 22:56:46 +05:30
```
Because template is [evaluated before](../../../ci/yaml/README.md#include) the pipeline
configuration, the last mention of the variable will take precedence.
2020-05-24 23:13:21 +05:30
### Overriding Dependency Scanning jobs
2019-07-31 22:56:46 +05:30
2020-04-22 19:07:51 +05:30
CAUTION: **Deprecation:**
Beginning in GitLab 13.0, the use of [`only` and `except`](../../../ci/yaml/README.md#onlyexcept-basic)
is no longer supported. When overriding the template, you must use [`rules`](../../../ci/yaml/README.md#rules) instead.
2020-05-24 23:13:21 +05:30
To override a job definition (for example, to change properties like `variables` or `dependencies`),
declare a new job with the same name as the one to override. Place this new job after the template
inclusion and specify any additional keys under it. For example, this disables `DS_REMEDIATE` for
the `gemnasium` analyzer:
2019-07-31 22:56:46 +05:30
```yaml
include:
2020-03-13 15:44:24 +05:30
- template: Dependency-Scanning.gitlab-ci.yml
2019-07-31 22:56:46 +05:30
2020-05-24 23:13:21 +05:30
gemnasium-dependency_scanning:
2019-07-31 22:56:46 +05:30
variables:
2020-05-24 23:13:21 +05:30
DS_REMEDIATE: "false"
2019-07-31 22:56:46 +05:30
```
2019-09-30 21:07:59 +05:30
### Available variables
Dependency Scanning can be [configured](#customizing-the-dependency-scanning-settings)
using environment variables.
2020-04-08 14:13:33 +05:30
#### Configuring Dependency Scanning
The following variables allow configuration of global dependency scanning settings.
2020-04-22 19:07:51 +05:30
| Environment variable | Description |
| --------------------------------------- |------------ |
2020-05-24 23:13:21 +05:30
| `SECURE_ANALYZERS_PREFIX` | Override the name of the Docker registry providing the official default images (proxy). Read more about [customizing analyzers](analyzers.md). |
| `DS_ANALYZER_IMAGE_PREFIX` | **DEPRECATED:** Use `SECURE_ANALYZERS_PREFIX` instead. |
2020-04-22 19:07:51 +05:30
| `DS_DEFAULT_ANALYZERS` | Override the names of the official default images. Read more about [customizing analyzers](analyzers.md). |
2020-05-24 23:13:21 +05:30
| `DS_DISABLE_DIND` | Disable Docker-in-Docker and run analyzers [individually](#enabling-docker-in-docker). This variable is `true` by default. |
2020-04-22 19:07:51 +05:30
| `ADDITIONAL_CA_CERT_BUNDLE` | Bundle of CA certs to trust. |
2020-06-23 00:09:42 +05:30
| `DS_EXCLUDED_PATHS` | Exclude vulnerabilities from output based on the paths. A comma-separated list of patterns. Patterns can be globs, or file or folder paths (for example, `doc,spec`). Parent directories also match patterns. Default: `"spec, test, tests, tmp"` |
2020-04-22 19:07:51 +05:30
#### Configuring Docker-in-Docker orchestrator
2020-05-24 23:13:21 +05:30
The following variables configure the Docker-in-Docker orchestrator, and therefore are only used when the Docker-in-Docker mode is [enabled](#enabling-docker-in-docker).
2020-04-22 19:07:51 +05:30
2020-04-08 14:13:33 +05:30
| Environment variable | Default | Description |
| --------------------------------------- | ----------- | ----------- |
2020-05-24 23:13:21 +05:30
| `DS_ANALYZER_IMAGES` | | Comma-separated list of custom images. The official default images are still enabled. Read more about [customizing analyzers](analyzers.md). |
2020-04-08 14:13:33 +05:30
| `DS_ANALYZER_IMAGE_TAG` | | Override the Docker tag of the official default images. Read more about [customizing analyzers](analyzers.md). |
| `DS_PULL_ANALYZER_IMAGES` | | Pull the images from the Docker registry (set to `0` to disable). |
| `DS_DOCKER_CLIENT_NEGOTIATION_TIMEOUT` | 2m | Time limit for Docker client negotiation. Timeouts are parsed using Go's [`ParseDuration`](https://golang.org/pkg/time/#ParseDuration). Valid time units are `ns`, `us` (or `µs`), `ms`, `s`, `m`, or `h`. For example, `300ms`, `1.5h`, or `2h45m`. |
| `DS_PULL_ANALYZER_IMAGE_TIMEOUT` | 5m | Time limit when pulling an analyzer's image. Timeouts are parsed using Go's [`ParseDuration`](https://golang.org/pkg/time/#ParseDuration). Valid time units are `ns`, `us` (or `µs`), `ms`, `s`, `m`, or `h`. For example, `300ms`, `1.5h`, or `2h45m`. |
| `DS_RUN_ANALYZER_TIMEOUT` | 20m | Time limit when running an analyzer. Timeouts are parsed using Go's [`ParseDuration`](https://golang.org/pkg/time/#ParseDuration). Valid time units are `ns`, `us` (or `µs`), `ms`, `s`, `m`, or `h`. For example, `300ms`, `1.5h`, or `2h45m`. |
#### Configuring specific analyzers used by Dependency Scanning
The following variables are used for configuring specific analyzers (used for a specific language/framework).
| Environment variable | Analyzer | Default | Description |
| --------------------------------------- | ------------------ | ---------------------------- |------------ |
2020-05-24 23:13:21 +05:30
| `GEMNASIUM_DB_LOCAL_PATH` | `gemnasium` | `/gemnasium-db` | Path to local Gemnasium database. |
| `GEMNASIUM_DB_REMOTE_URL` | `gemnasium` | `https://gitlab.com/gitlab-org/security-products/gemnasium-db.git` | Repository URL for fetching the Gemnasium database. |
2020-04-08 14:13:33 +05:30
| `GEMNASIUM_DB_REF_NAME` | `gemnasium` | `master` | Branch name for remote repository database. `GEMNASIUM_DB_REMOTE_URL` is required. |
2020-05-24 23:13:21 +05:30
| `DS_REMEDIATE` | `gemnasium` | `"true"` | Enable automatic remediation of vulnerable dependencies. |
2020-04-08 14:13:33 +05:30
| `PIP_INDEX_URL` | `gemnasium-python` | `https://pypi.org/simple` | Base URL of Python Package Index. |
2020-05-24 23:13:21 +05:30
| `PIP_EXTRA_INDEX_URL` | `gemnasium-python` | | Array of [extra URLs](https://pip.pypa.io/en/stable/reference/pip_install/#cmdoption-extra-index-url) of package indexes to use in addition to `PIP_INDEX_URL`. Comma-separated. |
2020-04-08 14:13:33 +05:30
| `PIP_REQUIREMENTS_FILE` | `gemnasium-python` | | Pip requirements file to be scanned. |
2020-06-23 00:09:42 +05:30
| `DS_PIP_VERSION` | `gemnasium-python` | | Force the install of a specific pip version (example: `"19.3"`), otherwise the pip installed in the Docker image is used. ([Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/12811) in GitLab 12.7) |
| `DS_PIP_DEPENDENCY_PATH` | `gemnasium-python` | | Path to load Python pip dependencies from. ([Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/12412) in GitLab 12.2) |
| `DS_PYTHON_VERSION` | `retire.js` | | Version of Python. If set to 2, dependencies are installed using Python 2.7 instead of Python 3.6. ([Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/12296) in GitLab 12.1)|
2020-05-24 23:13:21 +05:30
| `MAVEN_CLI_OPTS` | `gemnasium-maven` | `"-DskipTests --batch-mode"` | List of command line arguments that will be passed to `maven` by the analyzer. See an example for [using private repositories](../index.md#using-private-maven-repos). |
| `GRADLE_CLI_OPTS` | `gemnasium-maven` | | List of command line arguments that will be passed to `gradle` by the analyzer. |
| `SBT_CLI_OPTS` | `gemnasium-maven` | | List of command-line arguments that the analyzer will pass to `sbt`. |
| `BUNDLER_AUDIT_UPDATE_DISABLED` | `bundler-audit` | `"false"` | Disable automatic updates for the `bundler-audit` analyzer. Useful if you're running Dependency Scanning in an offline, air-gapped environment.|
2020-04-08 14:13:33 +05:30
| `BUNDLER_AUDIT_ADVISORY_DB_URL` | `bundler-audit` | `https://github.com/rubysec/ruby-advisory-db` | URL of the advisory database used by bundler-audit. |
| `BUNDLER_AUDIT_ADVISORY_DB_REF_NAME` | `bundler-audit` | `master` | Git ref for the advisory database specified by `BUNDLER_AUDIT_ADVISORY_DB_URL`. |
2020-04-22 19:07:51 +05:30
| `RETIREJS_JS_ADVISORY_DB` | `retire.js` | `https://raw.githubusercontent.com/RetireJS/retire.js/master/repository/jsrepository.json` | Path or URL to `retire.js` JS vulnerability data file. Note that if the URL hosting the data file uses a custom SSL certificate, for example in an offline installation, you can pass the certificate in the `ADDITIONAL_CA_CERT_BUNDLE` environment variable. |
| `RETIREJS_NODE_ADVISORY_DB` | `retire.js` | `https://raw.githubusercontent.com/RetireJS/retire.js/master/repository/npmrepository.json` | Path or URL to `retire.js` node vulnerability data file. Note that if the URL hosting the data file uses a custom SSL certificate, for example in an offline installation, you can pass the certificate in the `ADDITIONAL_CA_CERT_BUNDLE` environment variable. |
| `RETIREJS_ADVISORY_DB_INSECURE` | `retire.js` | `false` | Enable fetching remote JS and Node vulnerability data files (defined by the `RETIREJS_JS_ADVISORY_DB` and `RETIREJS_NODE_ADVISORY_DB` variables) from hosts using an insecure or self-signed SSL (TLS) certificate. |
2019-12-26 22:10:19 +05:30
### Using private Maven repos
2020-05-24 23:13:21 +05:30
If your private Maven repository requires login credentials,
2020-04-22 19:07:51 +05:30
you can use the `MAVEN_CLI_OPTS` environment variable.
2020-05-24 23:13:21 +05:30
Read more on [how to use private Maven repositories](../index.md#using-private-maven-repos).
2019-12-26 22:10:19 +05:30
2020-05-24 23:13:21 +05:30
### Enabling Docker-in-Docker
2019-12-26 22:10:19 +05:30
2020-06-23 00:09:42 +05:30
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/12487) in GitLab Ultimate 12.5.
2019-12-26 22:10:19 +05:30
2020-05-24 23:13:21 +05:30
If needed, you can enable Docker-in-Docker to restore the Dependency Scanning behavior that existed
prior to GitLab 13.0. Follow these steps to do so:
2019-12-26 22:10:19 +05:30
2020-05-24 23:13:21 +05:30
1. Configure GitLab Runner with Docker-in-Docker in [privileged mode](https://docs.gitlab.com/runner/executors/docker.html#use-docker-in-docker-with-privileged-mode).
1. Set the `DS_DISABLE_DIND` variable to `false`:
2019-12-26 22:10:19 +05:30
2020-05-24 23:13:21 +05:30
```yaml
include:
- template: Dependency-Scanning.gitlab-ci.yml
2019-12-26 22:10:19 +05:30
2020-05-24 23:13:21 +05:30
variables:
DS_DISABLE_DIND: "false"
```
2019-12-04 20:38:33 +05:30
2020-05-24 23:13:21 +05:30
This creates a single `dependency_scanning` job in your CI/CD pipeline instead of multiple
`<analyzer-name>-dependency_scanning` jobs.
2020-04-22 19:07:51 +05:30
2019-12-04 20:38:33 +05:30
## Interacting with the vulnerabilities
Once a vulnerability is found, you can interact with it. Read more on how to
[interact with the vulnerabilities](../index.md#interacting-with-the-vulnerabilities).
## Solutions for vulnerabilities (auto-remediation)
Some vulnerabilities can be fixed by applying the solution that GitLab
2020-05-24 23:13:21 +05:30
automatically generates. Read more about the
[solutions for vulnerabilities](../index.md#solutions-for-vulnerabilities-auto-remediation).
2019-12-04 20:38:33 +05:30
## Security Dashboard
The Security Dashboard is a good place to get an overview of all the security
vulnerabilities in your groups, projects and pipelines. Read more about the
[Security Dashboard](../security_dashboard/index.md).
## Vulnerabilities database update
For more information about the vulnerabilities database update, check the
[maintenance table](../index.md#maintenance-and-update-of-the-vulnerabilities-database).
## Dependency List
An additional benefit of Dependency Scanning is the ability to view your
project's dependencies and their known vulnerabilities. Read more about
the [Dependency List](../dependency_list/index.md).
2019-07-31 22:56:46 +05:30
2019-09-04 21:01:54 +05:30
## Reports JSON format
2020-06-23 00:09:42 +05:30
The Dependency Scanning tool emits a JSON report file. For more information, see the
[schema for this report](https://gitlab.com/gitlab-org/security-products/security-report-schemas/-/blob/master/dist/dependency-scanning-report-format.json).
2019-09-04 21:01:54 +05:30
2020-06-23 00:09:42 +05:30
Here's an example Dependency Scanning report:
2019-09-04 21:01:54 +05:30
```json-doc
{
"version": "2.0",
"vulnerabilities": [
{
2020-04-22 19:07:51 +05:30
"id": "51e83874-0ff6-4677-a4c5-249060554eae",
2019-09-04 21:01:54 +05:30
"category": "dependency_scanning",
"name": "Regular Expression Denial of Service",
"message": "Regular Expression Denial of Service in debug",
"description": "The debug module is vulnerable to regular expression denial of service when untrusted user input is passed into the `o` formatter. It takes around 50k characters to block for 2 seconds making this a low severity issue.",
"severity": "Unknown",
"solution": "Upgrade to latest versions.",
"scanner": {
"id": "gemnasium",
"name": "Gemnasium"
},
"location": {
"file": "yarn.lock",
"dependency": {
"package": {
"name": "debug"
},
"version": "1.0.5"
}
},
"identifiers": [
{
"type": "gemnasium",
"name": "Gemnasium-37283ed4-0380-40d7-ada7-2d994afcc62a",
"value": "37283ed4-0380-40d7-ada7-2d994afcc62a",
"url": "https://deps.sec.gitlab.com/packages/npm/debug/versions/1.0.5/advisories"
}
],
"links": [
{
"url": "https://nodesecurity.io/advisories/534"
},
{
"url": "https://github.com/visionmedia/debug/issues/501"
},
{
"url": "https://github.com/visionmedia/debug/pull/504"
}
]
},
{
2020-04-22 19:07:51 +05:30
"id": "5d681b13-e8fa-4668-957e-8d88f932ddc7",
2019-09-04 21:01:54 +05:30
"category": "dependency_scanning",
"name": "Authentication bypass via incorrect DOM traversal and canonicalization",
"message": "Authentication bypass via incorrect DOM traversal and canonicalization in saml2-js",
"description": "Some XML DOM traversal and canonicalization APIs may be inconsistent in handling of comments within XML nodes. Incorrect use of these APIs by some SAML libraries results in incorrect parsing of the inner text of XML nodes such that any inner text after the comment is lost prior to cryptographically signing the SAML message. Text after the comment therefore has no impact on the signature on the SAML message.\r\n\r\nA remote attacker can modify SAML content for a SAML service provider without invalidating the cryptographic signature, which may allow attackers to bypass primary authentication for the affected SAML service provider.",
"severity": "Unknown",
"solution": "Upgrade to fixed version.\r\n",
"scanner": {
"id": "gemnasium",
"name": "Gemnasium"
},
"location": {
"file": "yarn.lock",
"dependency": {
"package": {
"name": "saml2-js"
},
"version": "1.5.0"
}
},
"identifiers": [
{
"type": "gemnasium",
"name": "Gemnasium-9952e574-7b5b-46fa-a270-aeb694198a98",
"value": "9952e574-7b5b-46fa-a270-aeb694198a98",
"url": "https://deps.sec.gitlab.com/packages/npm/saml2-js/versions/1.5.0/advisories"
},
{
"type": "cve",
"name": "CVE-2017-11429",
"value": "CVE-2017-11429",
"url": "https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2017-11429"
}
],
"links": [
{
"url": "https://github.com/Clever/saml2/commit/3546cb61fd541f219abda364c5b919633609ef3d#diff-af730f9f738de1c9ad87596df3f6de84R279"
},
{
"url": "https://github.com/Clever/saml2/issues/127"
},
{
"url": "https://www.kb.cert.org/vuls/id/475445"
}
]
}
],
"remediations": [
{
"fixes": [
{
2020-04-22 19:07:51 +05:30
"id": "5d681b13-e8fa-4668-957e-8d88f932ddc7",
2019-09-04 21:01:54 +05:30
}
],
"summary": "Upgrade saml2-js",
"diff": "ZGlmZiAtLWdpdCBhL...OR0d1ZUc2THh3UT09Cg==" // some content is omitted for brevity
}
]
}
```
2019-09-30 21:07:59 +05:30
## Versioning and release process
Please check the [Release Process documentation](https://gitlab.com/gitlab-org/security-products/release/blob/master/docs/release_process.md).
2019-09-04 21:01:54 +05:30
## Contributing to the vulnerability database
You can search the [gemnasium-db](https://gitlab.com/gitlab-org/security-products/gemnasium-db) project
to find a vulnerability in the Gemnasium database.
You can also [submit new vulnerabilities](https://gitlab.com/gitlab-org/security-products/gemnasium-db/blob/master/CONTRIBUTING.md).
2019-10-12 21:52:04 +05:30
2020-04-22 19:07:51 +05:30
## Running Dependency Scanning in an offline environment
For self-managed GitLab instances in an environment with limited, restricted, or intermittent access
2020-05-24 23:13:21 +05:30
to external resources through the internet, some adjustments are required for Dependency Scanning
jobs to run successfully. For more information, see [Offline environments](../offline_deployments/index.md).
2020-04-22 19:07:51 +05:30
### Requirements for offline Dependency Scanning
Here are the requirements for using Dependency Scanning in an offline environment:
2020-05-24 23:13:21 +05:30
- Keep Docker-In-Docker disabled (default).
2020-04-22 19:07:51 +05:30
- GitLab Runner with the [`docker` or `kubernetes` executor](#requirements).
2020-05-24 23:13:21 +05:30
- Docker Container Registry with locally available copies of Dependency Scanning [analyzer](https://gitlab.com/gitlab-org/security-products/analyzers) images.
2020-04-22 19:07:51 +05:30
- Host an offline Git copy of the [gemnasium-db advisory database](https://gitlab.com/gitlab-org/security-products/gemnasium-db/)
- _Only if scanning Ruby projects_: Host an offline Git copy of the [advisory database](https://github.com/rubysec/ruby-advisory-db).
- _Only if scanning npm/yarn projects_: Host an offline copy of the [retire.js](https://github.com/RetireJS/retire.js/) [node](https://github.com/RetireJS/retire.js/blob/master/repository/npmrepository.json) and [js](https://github.com/RetireJS/retire.js/blob/master/repository/jsrepository.json) advisory databases.
NOTE: **Note:**
GitLab Runner has a [default `pull policy` of `always`](https://docs.gitlab.com/runner/executors/docker.html#using-the-always-pull-policy),
2020-05-24 23:13:21 +05:30
meaning the Runner tries to pull Docker images from the GitLab container registry even if a local
2020-04-22 19:07:51 +05:30
copy is available. GitLab Runner's [`pull_policy` can be set to `if-not-present`](https://docs.gitlab.com/runner/executors/docker.html#using-the-if-not-present-pull-policy)
in an offline environment if you prefer using only locally available Docker images. However, we
2020-05-24 23:13:21 +05:30
recommend keeping the pull policy setting to `always` if not in an offline environment, as this
enables the use of updated scanners in your CI/CD pipelines.
2020-04-22 19:07:51 +05:30
### Make GitLab Dependency Scanning analyzer images available inside your Docker registry
2020-05-24 23:13:21 +05:30
For Dependency Scanning with all [supported languages and frameworks](#supported-languages-and-package-managers),
import the following default Dependency Scanning analyzer images from `registry.gitlab.com` into
your [local Docker container registry](../../packages/container_registry/index.md):
2020-04-22 19:07:51 +05:30
```plaintext
registry.gitlab.com/gitlab-org/security-products/analyzers/gemnasium:2
registry.gitlab.com/gitlab-org/security-products/analyzers/gemnasium-maven:2
registry.gitlab.com/gitlab-org/security-products/analyzers/gemnasium-python:2
registry.gitlab.com/gitlab-org/security-products/analyzers/retire.js:2
registry.gitlab.com/gitlab-org/security-products/analyzers/bundler-audit:2
```
The process for importing Docker images into a local offline Docker registry depends on
**your network security policy**. Please consult your IT staff to find an accepted and approved
2020-05-24 23:13:21 +05:30
process by which external resources can be imported or temporarily accessed.
Note that these scanners are [updated periodically](../index.md#maintenance-and-update-of-the-vulnerabilities-database)
with new definitions, so consider if you can make periodic updates yourself.
2020-04-22 19:07:51 +05:30
For details on saving and transporting Docker images as a file, see Docker's documentation on
[`docker save`](https://docs.docker.com/engine/reference/commandline/save/), [`docker load`](https://docs.docker.com/engine/reference/commandline/load/),
[`docker export`](https://docs.docker.com/engine/reference/commandline/export/), and [`docker import`](https://docs.docker.com/engine/reference/commandline/import/).
2020-05-24 23:13:21 +05:30
### Set Dependency Scanning CI job variables to use local Dependency Scanning analyzers
2020-04-22 19:07:51 +05:30
2020-05-24 23:13:21 +05:30
Add the following configuration to your `.gitlab-ci.yml` file. You must replace
`DS_ANALYZER_IMAGE_PREFIX` to refer to your local Docker container registry:
2020-04-22 19:07:51 +05:30
```yaml
include:
- template: Dependency-Scanning.gitlab-ci.yml
variables:
DS_ANALYZER_IMAGE_PREFIX: "docker-registry.example.com/analyzers"
2020-05-24 23:13:21 +05:30
GEMNASIUM_DB_REMOTE_URL: "gitlab.example.com/gemnasium-db.git"
GIT_SSL_NO_VERIFY: "true"
2020-04-22 19:07:51 +05:30
```
See explanations of the variables above in the [configuration section](#configuration).
### Specific settings for languages and package managers
2020-05-24 23:13:21 +05:30
See the following sections for configuring specific languages and package managers.
2020-04-22 19:07:51 +05:30
#### JavaScript (npm and yarn) projects
Add the following to the variables section of `.gitlab-ci.yml`:
```yaml
RETIREJS_JS_ADVISORY_DB: "example.com/jsrepository.json"
RETIREJS_NODE_ADVISORY_DB: "example.com/npmrepository.json"
```
#### Ruby (gem) projects
Add the following to the variables section of `.gitlab-ci.yml`:
```yaml
BUNDLER_AUDIT_ADVISORY_DB_REF_NAME: "master"
BUNDLER_AUDIT_ADVISORY_DB_URL: "gitlab.example.com/ruby-advisory-db.git"
```
#### Python (setuptools)
2020-05-24 23:13:21 +05:30
When using self-signed certificates for your private PyPi repository, no extra job configuration (aside
2020-04-22 19:07:51 +05:30
from the template `.gitlab-ci.yml` above) is needed. However, you must update your `setup.py` to
2020-05-24 23:13:21 +05:30
ensure that it can reach your private repository. Here is an example configuration:
2020-04-22 19:07:51 +05:30
2020-05-24 23:13:21 +05:30
1. Update `setup.py` to create a `dependency_links` attribute pointing at your private repository for each
2020-04-22 19:07:51 +05:30
dependency in the `install_requires` list:
2020-06-23 00:09:42 +05:30
```python
install_requires=['pyparsing>=2.0.3'],
dependency_links=['https://pypi.example.com/simple/pyparsing'],
```
2020-04-22 19:07:51 +05:30
1. Fetch the certificate from your repository URL and add it to the project:
2020-06-23 00:09:42 +05:30
```shell
echo -n | openssl s_client -connect pypi.example.com:443 | sed -ne '/-BEGIN CERTIFICATE-/,/-END CERTIFICATE-/p' > internal.crt
```
2020-04-22 19:07:51 +05:30
1. Point `setup.py` at the newly downloaded certificate:
2020-06-23 00:09:42 +05:30
```python
import setuptools.ssl_support
setuptools.ssl_support.cert_paths = ['internal.crt']
```
2020-04-22 19:07:51 +05:30
2020-05-24 23:13:21 +05:30
## Limitations
### Referencing local dependencies using a path in JavaScript projects
The [Retire.js](https://gitlab.com/gitlab-org/security-products/analyzers/retire.js) analyzer
doesn't support dependency references made with [local paths](https://docs.npmjs.com/files/package.json#local-paths)
in the `package.json` of JavaScript projects. The dependency scan outputs the following error for
such references:
```plaintext
ERROR: Could not find dependencies: <dependency-name>. You may need to run npm install
```
As a workaround, remove the [`retire.js`](analyzers.md#selecting-specific-analyzers) analyzer from
[DS_DEFAULT_ANALYZERS](#configuring-dependency-scanning).
2019-12-04 20:38:33 +05:30
## Troubleshooting
2019-10-12 21:52:04 +05:30
2020-06-23 00:09:42 +05:30
### `Error response from daemon: error processing tar file: docker-tar: relocation error`
2019-10-12 21:52:04 +05:30
2020-05-24 23:13:21 +05:30
This error occurs when the Docker version that runs the Dependency Scanning job is `19.03.00`.
Consider updating to Docker `19.03.1` or greater. Older versions are not
2019-12-04 20:38:33 +05:30
affected. Read more in
2020-06-23 00:09:42 +05:30
[this issue](https://gitlab.com/gitlab-org/gitlab/-/issues/13830#note_211354992 "Current SAST container fails").