2019-07-25 10:16:25 -04:00
---
type: reference, howto
2020-05-26 14:08:20 -04:00
stage: Secure
group: Composition Analysis
2020-11-26 01:09:20 -05:00
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/#assignments
2019-07-25 10:16:25 -04:00
---
2019-07-08 04:50:38 -04:00
# Dependency Scanning **(ULTIMATE)**
2019-05-05 12:12:56 -04:00
2020-12-15 19:09:58 -05:00
The Dependency Scanning feature can automatically find security vulnerabilities in your
2020-09-29 02:09:45 -04:00
dependencies while you're developing and testing your applications. For example, dependency scanning
lets you know if your application uses an external (open source) library that is known to be
vulnerable. You can then take action to protect your application.
2019-05-05 12:12:56 -04:00
## Overview
2021-06-28 11:08:03 -04:00
If you're using [GitLab CI/CD ](../../../ci/index.md ), you can use dependency scanning to analyze
2020-09-29 02:09:45 -04:00
your dependencies for known vulnerabilities. GitLab scans all dependencies, including transitive
dependencies (also known as nested dependencies). You can take advantage of dependency scanning by
2021-02-17 13:09:19 -05:00
either:
- [Including the dependency scanning template ](#configuration )
in your existing `.gitlab-ci.yml` file.
- Implicitly using
the [auto dependency scanning ](../../../topics/autodevops/stages.md#auto-dependency-scanning )
provided by [Auto DevOps ](../../../topics/autodevops/index.md ).
2019-05-05 12:12:56 -04:00
2020-09-29 02:09:45 -04:00
GitLab checks the dependency scanning report, compares the found vulnerabilities
2019-09-10 06:06:45 -04:00
between the source and target branches, and shows the information on the
2021-08-06 14:09:57 -04:00
merge request. The results are sorted by the [severity ](../vulnerabilities/severities.md ) of the
vulnerability.
2019-05-05 12:12:56 -04:00
2020-09-29 02:09:45 -04:00
2019-05-05 12:12:56 -04:00
## Requirements
2020-09-29 02:09:45 -04:00
To run dependency scanning jobs, by default, you need GitLab Runner with the
2020-05-15 14:07:52 -04:00
[`docker` ](https://docs.gitlab.com/runner/executors/docker.html ) or
[`kubernetes` ](https://docs.gitlab.com/runner/install/kubernetes.html ) executor.
2020-09-14 23:09:24 -04:00
If you're using the shared runners on GitLab.com, this is enabled by default.
2019-05-05 12:12:56 -04:00
2020-12-04 16:09:29 -05:00
WARNING:
2020-09-14 23:09:24 -04:00
If you use your own runners, make sure your installed version of Docker
2020-04-14 20:09:27 -04:00
is **not** `19.03.0` . See [troubleshooting information ](#error-response-from-daemon-error-processing-tar-file-docker-tar-relocation-error ) for details.
2019-09-09 01:47:49 -04:00
2021-07-25 23:09:31 -04:00
WARNING:
Dependency Scanning does not support run-time installation of compilers and interpreters.
2021-08-10 08:11:00 -04:00
If you have need of this, please explain why by filling out the survey [here ](https://docs.google.com/forms/d/e/1FAIpQLScKo7xEYA65rOjPTGIufAyfjPGnCALSJZoTxBlvskfFMEOZMw/viewform ).
2021-07-25 23:09:31 -04:00
2019-05-05 12:12:56 -04:00
## Supported languages and package managers
2021-08-17 14:10:35 -04:00
Dependency Scanning automatically detects the languages used in the repository. All analyzers
matching the detected languages are run. There is usually no need to customize the selection of
analyzers. We recommend not specifying the analyzers so you automatically use the full selection
for best coverage, avoiding the need to make adjustments when there are deprecations or removals.
However, you can override the selection using the variable `DS_EXCLUDED_ANALYZERS` .
The language detection relies on CI job [`rules` ](../../../ci/yaml/index.md#rules ) and searches a
maximum of two directory levels from the repository's root. For example, the
2021-08-24 02:08:55 -04:00
`gemnasium-dependency_scanning` job is enabled if a repository contains either `Gemfile` ,
`api/Gemfile` , or `api/client/Gemfile` , but not if the only supported dependency file is `api/v1/client/Gemfile` .
2021-08-17 14:10:35 -04:00
2020-06-09 17:08:21 -04:00
The following languages and dependency managers are supported:
2021-08-12 02:10:10 -04:00
< style >
table.supported-languages tr:nth-child(even) {
background-color: transparent;
}
table.supported-languages td {
border-left: 1px solid #dbdbdb ;
border-right: 1px solid #dbdbdb ;
border-bottom: 1px solid #dbdbdb ;
}
table.supported-languages tr td:first-child {
border-left: 0;
}
table.supported-languages tr td:last-child {
border-right: 0;
}
table.supported-languages ul {
2021-09-27 08:13:56 -04:00
font-size: 1em;
2021-08-12 02:10:10 -04:00
list-style-type: none;
padding-left: 0px;
margin-bottom: 0px;
}
< / style >
2021-11-10 07:10:12 -05:00
<!-- markdownlint - disable MD044 -->
2021-08-12 02:10:10 -04:00
< table class = "supported-languages" >
< thead >
< tr >
< th > Language< / th >
2021-11-10 07:10:12 -05:00
< th > Language Versions< / th >
2021-08-12 02:10:10 -04:00
< th > Package Manager< / th >
< th > Supported files< / th >
< th > Analyzer< / th >
< th > < a href = "#how-multiple-files-are-processed" > Processes multiple files?< / a > < / th >
< / tr >
< / thead >
< tbody >
< tr >
< td rowspan = "2" > Ruby< / td >
2021-11-10 07:10:12 -05:00
< td rowspan = "2" > N/A< / td >
2021-08-12 02:10:10 -04:00
< td rowspan = "2" > < a href = "https://bundler.io/" > Bundler< / a > < / td >
< td >
< ul >
< li > < code > Gemfile.lock< / code > < / li >
< li > < code > gems.locked< / code > < / li >
< / ul >
< / td >
< td > < a href = "https://gitlab.com/gitlab-org/security-products/analyzers/gemnasium" > Gemnasium< / a > < / td >
< td > Y< / td >
< / tr >
< tr >
< td > < code > Gemfile.lock< / code > < / td >
< td > < a href = "https://github.com/rubysec/bundler-audit" > bundler-audit< / a > < / td >
< td > N< / td >
< / tr >
< tr >
< td > PHP< / td >
2021-11-10 07:10:12 -05:00
< td > N/A< / td >
2021-08-12 02:10:10 -04:00
< td > < a href = "https://getcomposer.org/" > Composer< / a > < / td >
< td > < code > composer.lock< / code > < / td >
< td > < a href = "https://gitlab.com/gitlab-org/security-products/analyzers/gemnasium" > Gemnasium< / a > < / td >
< td > Y< / td >
< / tr >
< tr >
< td > C< / td >
2021-11-10 07:10:12 -05:00
< td rowspan = "2" > N/A< / td >
2021-08-12 02:10:10 -04:00
< td rowspan = "2" > < a href = "https://conan.io/" > Conan< / a > < / td >
< td rowspan = "2" > < a href = "https://docs.conan.io/en/latest/versioning/lockfiles.html" > < code > conan.lock< / code > < / a > < / td >
< td rowspan = "2" > < a href = "https://gitlab.com/gitlab-org/security-products/analyzers/gemnasium" > Gemnasium< / a > < / td >
< td rowspan = "2" > Y< / td >
< / tr >
< tr >
< td > C++< / td >
< / tr >
< tr >
< td > Go< / td >
2021-11-10 07:10:12 -05:00
< td > N/A< / td >
< td > < a href = "https://golang.org/" > Go< / a > < / td >
2021-08-12 02:10:10 -04:00
< td > < code > go.sum< / code > < / td >
< td > < a href = "https://gitlab.com/gitlab-org/security-products/analyzers/gemnasium" > Gemnasium< / a > < / td >
< td > Y< / td >
< / tr >
< tr >
< td rowspan = "2" > Java< / td >
2021-11-10 07:10:12 -05:00
< td rowspan = "2" > 8, 11, 13, 14, 15, or 16< / td >
< td > < a href = "https://gradle.org/" > Gradle< / a > < sup > < b > < a href = "#notes-regarding-supported-languages-and-package-managers-1" > 1< / a > < / b > < / sup > < / td >
2021-08-12 02:10:10 -04:00
< td >
< ul >
< li > < code > build.gradle< / code > < / li >
< li > < code > build.gradle.kts< / code > < / li >
< / ul >
< / td >
< td > < a href = "https://gitlab.com/gitlab-org/security-products/analyzers/gemnasium" > Gemnasium< / a > < / td >
< td > N< / td >
< / tr >
< tr >
< td > < a href = "https://maven.apache.org/" > Maven< / a > < / td >
< td > < code > pom.xml< / code > < / td >
< td > < a href = "https://gitlab.com/gitlab-org/security-products/analyzers/gemnasium" > Gemnasium< / a > < / td >
< td > N< / td >
< / tr >
< tr >
< td rowspan = "3" > JavaScript< / td >
2021-11-10 07:10:12 -05:00
< td rowspan = "2" > N/A< / td >
2021-08-12 02:10:10 -04:00
< td rowspan = "2" > < a href = "https://www.npmjs.com/" > npm< / a > < / td >
< td >
< ul >
< li > < code > package-lock.json< / code > < / li >
< li > < code > npm-shrinkwrap.json< / code > < / li >
< / ul >
< / td >
< td > < a href = "https://gitlab.com/gitlab-org/security-products/analyzers/gemnasium" > Gemnasium< / a > < / td >
< td > Y< / td >
< / tr >
< tr >
< td > < code > package.json< / code > < / td >
< td > < a href = "https://retirejs.github.io/retire.js/" > Retire.js< / a > < / td >
< td > N< / td >
< / tr >
< tr >
2021-11-10 07:10:12 -05:00
< td > N/A< / td >
2021-08-12 02:10:10 -04:00
< td > < a href = "https://classic.yarnpkg.com/en/" > yarn< / a > < / td >
< td > < code > yarn.lock< / code > < / td >
< td > < a href = "https://gitlab.com/gitlab-org/security-products/analyzers/gemnasium" > Gemnasium< / a > < / td >
< td > Y< / td >
< / tr >
< tr >
< td > .NET< / td >
2021-11-10 07:10:12 -05:00
< td rowspan = "2" > N/A< / td >
2021-08-12 02:10:10 -04:00
< td rowspan = "2" > < a href = "https://www.nuget.org/" > NuGet< / a > < / td >
< td rowspan = "2" > < a href = "https://docs.microsoft.com/en-us/nuget/consume-packages/package-references-in-project-files#enabling-lock-file" > < code > packages.lock.json< / code > < / a > < / td >
< td rowspan = "2" > < a href = "https://gitlab.com/gitlab-org/security-products/analyzers/gemnasium" > Gemnasium< / a > < / td >
< td rowspan = "2" > Y< / td >
< / tr >
< tr >
< td > C#< / td >
< / tr >
< tr >
< td rowspan = "3" > Python< / td >
2021-11-10 07:10:12 -05:00
< td rowspan = "3" > 3.6< / td >
2021-08-12 02:10:10 -04:00
< td > < a href = "https://setuptools.readthedocs.io/en/latest/" > setuptools< / a > < / td >
< td > < code > setup.py< / code > < / td >
< td > < a href = "https://gitlab.com/gitlab-org/security-products/analyzers/gemnasium" > Gemnasium< / a > < / td >
< td > N< / td >
< / tr >
< tr >
< td > < a href = "https://pip.pypa.io/en/stable/" > pip< / a > < / td >
< td >
< ul >
< li > < code > requirements.txt< / code > < / li >
< li > < code > requirements.pip< / code > < / li >
< li > < code > requires.txt< / code > < / li >
< / ul >
< / td >
< td > < a href = "https://gitlab.com/gitlab-org/security-products/analyzers/gemnasium" > Gemnasium< / a > < / td >
< td > N< / td >
< / tr >
< tr >
< td > < a href = "https://pipenv.pypa.io/en/latest/" > Pipenv< / a > < / td >
< td >
< ul >
< li > < a href = "https://pipenv.pypa.io/en/latest/basics/#example-pipfile-pipfile-lock" > < code > Pipfile< / code > < / a > < / li >
2021-11-10 07:10:12 -05:00
< li > < a href = "https://pipenv.pypa.io/en/latest/basics/#example-pipfile-pipfile-lock" > < code > Pipfile.lock< / code > < / a > < sup > < b > < a href = "#notes-regarding-supported-languages-and-package-managers-2" > 2< / a > < / b > < / sup > < / li >
2021-08-12 02:10:10 -04:00
< / ul >
< / td >
< td > < a href = "https://gitlab.com/gitlab-org/security-products/analyzers/gemnasium" > Gemnasium< / a > < / td >
< td > N< / td >
< / tr >
< tr >
< td > Scala< / td >
2021-11-10 07:10:12 -05:00
< td > N/A< / td >
< td > < a href = "https://www.scala-sbt.org/" > sbt< / a > < sup > < b > < a href = "#notes-regarding-supported-languages-and-package-managers-3" > 3< / a > < / b > < / sup > < / td >
2021-08-12 02:10:10 -04:00
< td > < code > build.sbt< / code > < / td >
< td > < a href = "https://gitlab.com/gitlab-org/security-products/analyzers/gemnasium" > Gemnasium< / a > < / td >
< td > N< / td >
< / tr >
< / tbody >
< / table >
2021-11-10 07:10:12 -05:00
< ol >
< li >
< a id = "notes-regarding-supported-languages-and-package-managers-1" > < / a >
< p >
Although Gradle with Java 8 is supported, there are other issues such that Android project builds are not supported at this time.
Please see the backlog issue < a href = "https://gitlab.com/gitlab-org/gitlab/-/issues/336866" > Android support for Dependency
Scanning (gemnasium-maven)< / a > for more details.
< / p >
< / li >
< li >
< a id = "notes-regarding-supported-languages-and-package-managers-2" > < / a >
< p >
The presence of a < code > Pipfile.lock< / code > file alone will < i > not< / i > trigger the analyzer; the presence of a < code > Pipfile< / code > is
still required in order for the analyzer to be executed. However, if a < code > Pipfile.lock< / code > file is found, it will be used by
< code > Gemnasium< / code > to scan the exact package versions listed in this file.
< / p >
< p >
Support for < code > Pipfile.lock< / code > files without requiring the presence of a < code > Pipfile< / code > is tracked in
issue: < a href = "https://gitlab.com/gitlab-org/gitlab/-/issues/299294" > Dependency Scanning of Pipfile.lock without
installing project dependencies< / a > .
< / p >
< / li >
< li >
< a id = "notes-regarding-supported-languages-and-package-managers-3" > < / a >
< p >
Support for < a href = "https://www.scala-sbt.org/" > sbt< / a > 1.3 and above was added in GitLab 13.9.
< / p >
< / li >
< / ol >
2021-11-01 02:09:58 -04:00
<!-- markdownlint - enable MD044 -->
2021-11-10 07:10:12 -05:00
### How analyzers obtain dependency information
GitLab analyzers obtain dependency information using one of the following two methods:
1. [Parsing lockfiles directly. ](#obtaining-dependendency-information-by-parsing-lockfiles )
1. [Running a package manager or build tool to generate a dependency information file which is then parsed. ](#obtaining-dependendency-information-by-running-a-package-manager-to-generate-a-parsable-file )
#### Obtaining dependendency information by parsing lockfiles
2021-08-12 02:10:10 -04:00
2021-11-10 07:10:12 -05:00
The following package managers use lockfiles that GitLab analyzers are capable of parsing directly:
2021-08-25 08:11:32 -04:00
2021-11-10 07:10:12 -05:00
| Package Manager | Supported File Format Versions | Tested Versions |
| ------ | ------ | ------ |
| Bundler | N/A | [1.17.3 ](https://gitlab.com/gitlab-org/security-products/tests/ruby-bundler/-/blob/master/Gemfile.lock#L118 ), [2.1.4 ](https://gitlab.com/gitlab-org/security-products/tests/ruby-bundler/-/blob/bundler2-FREEZE/Gemfile.lock#L118 ) |
| Composer | N/A | [1.x ](https://gitlab.com/gitlab-org/security-products/tests/php-composer/-/blob/master/composer.lock ) |
| Conan | 0.4 | [1.x ](https://gitlab.com/gitlab-org/security-products/tests/c-conan/-/blob/master/conan.lock ) |
| Go | N/A | [1.x ](https://gitlab.com/gitlab-org/security-products/tests/go-modules/-/blob/master/go.mod ) |
| NuGet | v1 | [4.9 ](https://gitlab.com/gitlab-org/security-products/tests/csharp-nuget-dotnetcore/-/blob/master/src/web.api/packages.lock.json#L2 ) |
| npm | v1, v2 | [6.x ](https://gitlab.com/gitlab-org/security-products/tests/js-npm/-/blob/master/package-lock.json#L4 ), [7.x ](https://gitlab.com/gitlab-org/security-products/tests/js-npm/-/blob/lockfile-v2-FREEZE/package-lock.json#L4 ) |
| yarn | v1 | [1.x ](https://gitlab.com/gitlab-org/security-products/tests/js-yarn/-/blob/master/yarn.lock ) |
2021-08-12 02:10:10 -04:00
2021-11-10 07:10:12 -05:00
#### Obtaining dependendency information by running a package manager to generate a parsable file
2021-08-12 02:10:10 -04:00
2021-11-10 07:10:12 -05:00
To support the following package managers, the GitLab analyzers proceed in two steps:
1. Execute the package manager or a specific task, to export the dependency information.
1. Parse the exported dependency information.
| Package Manager | Preinstalled Versions | Tested Versions |
| ------ | ------ | ------ |
| Bundler | [2.1.4 ](https://gitlab.com/gitlab-org/security-products/analyzers/bundler-audit/-/blob/v2.11.3/Dockerfile#L15 )< sup >< b >< a href = "#exported-dependency-information-notes-1" > 1</ a ></ b ></ sup > | [1.17.3 ](https://gitlab.com/gitlab-org/security-products/tests/ruby-bundler/-/blob/master/Gemfile.lock#L118 ), [2.1.4 ](https://gitlab.com/gitlab-org/security-products/tests/ruby-bundler/-/blob/bundler2-FREEZE/Gemfile.lock#L118 ) |
| sbt | [1.3.8 ](https://gitlab.com/gitlab-org/security-products/analyzers/gemnasium-maven/-/blob/v2.23.0/config/.tool-versions#L4 ) | [1.0.4 ](https://gitlab.com/gitlab-org/security-products/analyzers/gemnasium-maven/-/blob/master/.gitlab-ci.yml#L263 ), [1.1.4 ](https://gitlab.com/gitlab-org/security-products/tests/scala-sbt-multiproject/-/blob/main/project/build.properties#L1 ), [1.1.6 ](https://gitlab.com/gitlab-org/security-products/analyzers/gemnasium-maven/-/blob/master/.gitlab-ci.yml#L272 ), [1.2.8 ](https://gitlab.com/gitlab-org/security-products/analyzers/gemnasium-maven/-/blob/master/.gitlab-ci.yml#L281 ), [1.3.12 ](https://gitlab.com/gitlab-org/security-products/analyzers/gemnasium-maven/-/blob/master/.gitlab-ci.yml#L290 ), [1.4.6 ](https://gitlab.com/gitlab-org/security-products/analyzers/gemnasium-maven/-/blob/master/.gitlab-ci.yml#L299 ) |
| Maven | [3.6.3 ](https://gitlab.com/gitlab-org/security-products/analyzers/gemnasium-maven/-/blob/v2.23.0/config/.tool-versions#L3 ) | [3.6.3 ](https://gitlab.com/gitlab-org/security-products/tests/java-maven/-/blob/master/pom.xml#L3 ) |
| Gradle | [6.7.1 ](https://gitlab.com/gitlab-org/security-products/analyzers/gemnasium-maven/-/blob/v2.23.0/config/.tool-versions#L5 ) | [5.6.4 ](https://gitlab.com/gitlab-org/security-products/tests/java-gradle/-/blob/master/gradle/wrapper/gradle-wrapper.properties#L3 ), [6.5 ](https://gitlab.com/gitlab-org/security-products/tests/java-gradle/-/blob/java-14/gradle/wrapper/gradle-wrapper.properties#L3 ), [6.7-rc-1 ](https://gitlab.com/gitlab-org/security-products/tests/java-gradle/-/blob/java-15/gradle/wrapper/gradle-wrapper.properties#L3 ), [7.0-rc-2 ](https://gitlab.com/gitlab-org/security-products/tests/java-gradle/-/blob/java-16/gradle/wrapper/gradle-wrapper.properties#L3 ) |
| setuptools | [50.3.2 ](https://gitlab.com/gitlab-org/security-products/analyzers/gemnasium/-/blob/v2.29.9/Dockerfile#L27 ) | |
| pip | [20.2.4 ](https://gitlab.com/gitlab-org/security-products/analyzers/gemnasium/-/blob/v2.29.9/Dockerfile#L26 ) | [20.x ](https://gitlab.com/gitlab-org/security-products/tests/python-pip/-/blob/master/requirements.txt ) |
| Pipenv | [2018.11.26 ](https://gitlab.com/gitlab-org/security-products/analyzers/gemnasium-python/-/blob/v2.18.4/requirements.txt#L13 ) | [2018.11.26 ](https://gitlab.com/gitlab-org/security-products/tests/python-pipenv/-/blob/pipfile-lock-FREEZE/Pipfile.lock#L6 )< sup >< b >< a href = "#exported-dependency-information-notes-2" > 2</ a ></ b ></ sup > , [2018.11.26 ](https://gitlab.com/gitlab-org/security-products/tests/python-pipenv/-/blob/master/Pipfile ) |
<!-- markdownlint - disable MD044 -->
< ol >
< li >
< a id = "exported-dependency-information-notes-1" > < / a >
< p >
The installed version of < code > Bundler< / code > is only used for the < a href = "https://gitlab.com/gitlab-org/security-products/analyzers/bundler-audit" > bundler-audit< / a > analyzer, and is not used for < a href = "https://gitlab.com/gitlab-org/security-products/analyzers/gemnasium" > gemnasium< / a >
< / p >
< / li >
< li >
< a id = "exported-dependency-information-notes-2" > < / a >
< p >
This test confirms that if a < code > Pipfile.lock< / code > file is found, it will be used by < a href = "https://gitlab.com/gitlab-org/security-products/analyzers/gemnasium" > Gemnasium< / a > to scan the exact package versions listed in this file.
< / p >
< / li >
< / ol >
<!-- markdownlint - enable MD044 -->
2021-01-17 19:11:12 -05:00
2021-08-12 02:10:10 -04:00
### How analyzers are triggered
GitLab relies on [`rules:exists` ](../../../ci/yaml/index.md#rulesexists ) to start the relevant analyzers for the languages detected by the presence of the
`Supported files` in the repository as shown in the [table above ](#supported-languages-and-package-managers ).
The current detection logic limits the maximum search depth to two levels. For example, the `gemnasium-dependency_scanning` job is enabled if
2021-08-24 02:08:55 -04:00
a repository contains either a `Gemfile.lock` , `api/Gemfile.lock` , or `api/client/Gemfile.lock` , but not if the only supported dependency file is `api/v1/client/Gemfile.lock` .
2021-08-12 02:10:10 -04:00
### How multiple files are processed
NOTE:
If you've run into problems while scanning multiple files, please contribute a comment to
[this issue ](https://gitlab.com/gitlab-org/gitlab/-/issues/337056 ).
#### Ruby
The following analyzers are executed, each of which have different behavior when processing multiple files:
- [Gemnasium ](https://gitlab.com/gitlab-org/security-products/analyzers/gemnasium )
Supports multiple lockfiles.
- [bundler-audit ](https://github.com/rubysec/bundler-audit )
Does not support multiple lockfiles. When multiple lockfiles exist, `bundler-audit`
analyzes the first lockfile discovered while traversing the directory tree in alphabetical order.
We execute both analyzers because they use different sources of vulnerability data. The result is more comprehensive analysis than if only one was executed.
#### Python
2021-08-22 17:10:46 -04:00
We only execute one installation in the directory where a requirements file has been detected, such as `requirements.txt` or any
2021-08-12 02:10:10 -04:00
variation of this file (for example, `requirements.pip` or `requires.txt` ).
#### Java and Scala
We only execute one build in the directory where a build file has been detected, such as `build.sbt` or `build.gradle` .
2021-09-16 08:09:35 -04:00
Please note, we support the following types of Java project structures:
2021-08-12 02:10:10 -04:00
- [multi-project sbt builds ](https://www.scala-sbt.org/1.x/docs/Multi-Project.html )
- [multi-project gradle builds ](https://docs.gradle.org/current/userguide/intro_multi_project_builds.html )
- [multi-module maven projects ](https://maven.apache.org/pom.html#Aggregation )
#### JavaScript
The following analyzers are executed, each of which have different behavior when processing multiple files:
- [Gemnasium ](https://gitlab.com/gitlab-org/security-products/analyzers/gemnasium )
Supports multiple lockfiles
- [Retire.js ](https://retirejs.github.io/retire.js/ )
Does not support multiple lockfiles. When multiple lockfiles exist, `Retire.js`
analyzes the first lockfile discovered while traversing the directory tree in alphabetical order.
We execute both analyzers because they use different sources of vulnerability data. The result is more comprehensive analysis than if only one was executed.
#### PHP, Go, C, C++, .NET, C#
The analyzer for these languages supports multiple lockfiles.
2021-10-25 17:12:12 -04:00
### Support for additional languages
2021-08-12 02:10:10 -04:00
2021-10-25 17:12:12 -04:00
Support for additional languages, dependency managers, and dependency files are tracked in the following issues:
2020-06-09 17:08:21 -04:00
2020-11-12 19:09:49 -05:00
| Package Managers | Languages | Supported files | Scan tools | Issue |
| ------------------- | --------- | --------------- | ---------- | ----- |
2021-03-07 19:09:10 -05:00
| [Poetry ](https://python-poetry.org/ ) | Python | `poetry.lock` | [Gemnasium ](https://gitlab.com/gitlab-org/security-products/analyzers/gemnasium ) | [GitLab#7006 ](https://gitlab.com/gitlab-org/gitlab/-/issues/7006 ) |
2019-05-05 12:12:56 -04:00
2021-10-25 17:12:12 -04:00
For workarounds, see the [Troubleshooting section ](#troubleshooting ).
2020-03-20 05:09:22 -04:00
## Contribute your scanner
The [Security Scanner Integration ](../../../development/integrations/secure.md ) documentation explains how to integrate other security scanners into GitLab.
2019-07-09 12:41:33 -04:00
## Configuration
2019-05-05 12:12:56 -04:00
2020-09-29 02:09:45 -04:00
To enable dependency scanning for GitLab 11.9 and later, you must
2021-06-28 17:10:13 -04:00
[include ](../../../ci/yaml/index.md#includetemplate ) the
2021-06-08 14:10:23 -04:00
[`Dependency-Scanning.gitlab-ci.yml` template ](https://gitlab.com/gitlab-org/gitlab/-/blob/master/lib/gitlab/ci/templates/Security/Dependency-Scanning.gitlab-ci.yml )
2020-08-09 17:10:01 -04:00
that is provided as a part of your GitLab installation.
2019-07-09 12:41:33 -04:00
For GitLab versions earlier than 11.9, you can copy and use the job as defined
that template.
2019-05-05 12:12:56 -04:00
2019-07-09 12:41:33 -04:00
Add the following to your `.gitlab-ci.yml` file:
2019-05-05 12:12:56 -04:00
```yaml
include:
2021-09-29 02:09:19 -04:00
- template: Security/Dependency-Scanning.gitlab-ci.yml
2019-05-05 12:12:56 -04:00
```
2020-09-29 02:09:45 -04:00
The included template creates dependency scanning jobs in your CI/CD
2020-08-09 17:10:01 -04:00
pipeline and scans your project's source code for possible vulnerabilities.
The results are saved as a
2021-06-28 17:10:13 -04:00
[dependency scanning report artifact ](../../../ci/yaml/index.md#artifactsreportsdependency_scanning )
2019-05-05 12:12:56 -04:00
that you can later download and analyze. Due to implementation limitations, we
2020-09-29 02:09:45 -04:00
always take the latest dependency scanning artifact available.
2019-05-05 12:12:56 -04:00
2021-07-12 17:09:24 -04:00
### Enable Dependency Scanning via an automatic merge request
2021-10-26 11:09:27 -04:00
> - [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/4908) in GitLab 14.1 [with a flag](../../../administration/feature_flags.md) named `sec_dependency_scanning_ui_enable`. Enabled by default.
> - [Enabled on self-managed](https://gitlab.com/gitlab-org/gitlab/-/issues/282533) in GitLab 14.1.
2021-08-12 05:09:05 -04:00
> - [Feature flag sec_dependency_scanning_ui_enable removed](https://gitlab.com/gitlab-org/gitlab/-/issues/326005) in GitLab 14.2.
2021-07-12 17:09:24 -04:00
To enable Dependency Scanning in a project, you can create a merge request
from the Security Configuration page.
1. In the project where you want to enable Dependency Scanning, navigate to
**Security & Compliance > Configuration** .
1. In the **Dependency Scanning** row, select **Configure via Merge Request** .
This automatically creates a merge request with the changes necessary to enable Dependency Scanning
that you can review and merge to complete the configuration.
2020-09-29 02:09:45 -04:00
### Customizing the dependency scanning settings
2019-05-05 12:12:56 -04:00
2021-05-25 11:10:33 -04:00
The dependency scanning settings can be changed through [CI/CD variables ](#available-cicd-variables ) by using the
2021-06-28 17:10:13 -04:00
[`variables` ](../../../ci/yaml/index.md#variables ) parameter in `.gitlab-ci.yml` .
2019-05-05 12:12:56 -04:00
For example:
```yaml
include:
2021-09-29 02:09:19 -04:00
- template: Security/Dependency-Scanning.gitlab-ci.yml
2019-05-05 12:12:56 -04:00
variables:
2020-12-17 13:10:14 -05:00
SECURE_LOG_LEVEL: error
2019-05-05 12:12:56 -04:00
```
2021-06-28 17:10:13 -04:00
Because template is [evaluated before ](../../../ci/yaml/index.md#include ) the pipeline
2020-08-09 17:10:01 -04:00
configuration, the last mention of the variable takes precedence.
2019-05-05 12:12:56 -04:00
2020-09-29 02:09:45 -04:00
### Overriding dependency scanning jobs
2019-05-05 12:12:56 -04:00
2020-12-04 16:09:29 -05:00
WARNING:
2021-06-28 17:10:13 -04:00
Beginning in GitLab 13.0, the use of [`only` and `except` ](../../../ci/yaml/index.md#only--except )
is no longer supported. When overriding the template, you must use [`rules` ](../../../ci/yaml/index.md#rules ) instead.
2020-04-21 11:21:10 -04:00
2020-05-15 14:07:52 -04:00
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-05-05 12:12:56 -04:00
```yaml
include:
2021-09-29 02:09:19 -04:00
- template: Security/Dependency-Scanning.gitlab-ci.yml
2019-05-05 12:12:56 -04:00
2020-05-15 14:07:52 -04:00
gemnasium-dependency_scanning:
2019-05-05 12:12:56 -04:00
variables:
2020-05-15 14:07:52 -04:00
DS_REMEDIATE: "false"
2019-05-05 12:12:56 -04:00
```
2020-12-14 16:09:47 -05:00
To override the `dependencies: []` attribute, add an override job as above, targeting this attribute:
```yaml
include:
2021-09-29 02:09:19 -04:00
- template: Security/Dependency-Scanning.gitlab-ci.yml
2020-12-14 16:09:47 -05:00
gemnasium-dependency_scanning:
dependencies: ["build"]
```
2021-05-25 11:10:33 -04:00
### Available CI/CD variables
2019-06-07 06:48:46 -04:00
2020-09-29 02:09:45 -04:00
Dependency scanning can be [configured ](#customizing-the-dependency-scanning-settings )
2019-06-07 06:48:46 -04:00
using environment variables.
2020-09-29 02:09:45 -04:00
#### Configuring dependency scanning
2020-03-10 08:08:16 -04:00
The following variables allow configuration of global dependency scanning settings.
2021-02-15 04:09:00 -05:00
| CI/CD variables | Description |
| ----------------------------|------------ |
| `ADDITIONAL_CA_CERT_BUNDLE` | Bundle of CA certs to trust. The bundle of certificates provided here is also used by other tools during the scanning process, such as `git` , `yarn` , or `npm` . See [Using a custom SSL CA certificate authority ](#using-a-custom-ssl-ca-certificate-authority ) for more details. |
2021-05-17 17:10:42 -04:00
| `DS_EXCLUDED_ANALYZERS` | Specify the analyzers (by name) to exclude from Dependency Scanning. For more information, see [Dependency Scanning Analyzers ](analyzers.md ). |
| `DS_DEFAULT_ANALYZERS` | ([**DEPRECATED - use `DS_EXCLUDED_ANALYZERS` instead**](https://gitlab.com/gitlab-org/gitlab/-/issues/287691)) Override the names of the official default images. For more information, see [Dependency Scanning Analyzers ](analyzers.md ). |
2021-02-15 04:09:00 -05:00
| `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"` . |
| `SECURE_ANALYZERS_PREFIX` | Override the name of the Docker registry providing the official default images (proxy). Read more about [customizing analyzers ](analyzers.md ). |
| `SECURE_LOG_LEVEL` | Set the minimum logging level. Messages of this logging level or higher are output. From highest to lowest severity, the logging levels are: `fatal` , `error` , `warn` , `info` , `debug` . [Introduced ](https://gitlab.com/gitlab-org/gitlab/-/issues/10880 ) in GitLab 13.1. Default: `info` . |
2020-04-08 14:09:16 -04:00
2020-09-29 02:09:45 -04:00
#### Configuring specific analyzers used by dependency scanning
2020-03-10 08:08:16 -04:00
The following variables are used for configuring specific analyzers (used for a specific language/framework).
2021-02-15 04:09:00 -05:00
| CI/CD variable | Analyzer | Default | Description |
| ------------------------------------ | ------------------ | ---------------------------- |------------ |
| `BUNDLER_AUDIT_UPDATE_DISABLED` | `bundler-audit` | `"false"` | Disable automatic updates for the `bundler-audit` analyzer. Use if you're running dependency scanning in an offline, air-gapped environment.|
| `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` . |
| `GEMNASIUM_DB_LOCAL_PATH` | `gemnasium` | `/gemnasium-db` | Path to local Gemnasium database. |
2021-03-17 14:09:01 -04:00
| `GEMNASIUM_DB_UPDATE_DISABLED` | `gemnasium` | `"false"` | Disable automatic updates for the `gemnasium-db` advisory database (For usage see: [examples ](#hosting-a-copy-of-the-gemnasium_db-advisory-database ))|
2021-02-15 04:09:00 -05:00
| `GEMNASIUM_DB_REMOTE_URL` | `gemnasium` | `https://gitlab.com/gitlab-org/security-products/gemnasium-db.git` | Repository URL for fetching the Gemnasium database. |
| `GEMNASIUM_DB_REF_NAME` | `gemnasium` | `master` | Branch name for remote repository database. `GEMNASIUM_DB_REMOTE_URL` is required. |
| `DS_REMEDIATE` | `gemnasium` | `"true"` | Enable automatic remediation of vulnerable dependencies. |
2021-07-12 20:08:33 -04:00
| `DS_JAVA_VERSION` | `gemnasium-maven` | `11` | Version of Java. Available versions: `8` , `11` , `13` , `14` , `15` , `16` . |
2021-02-15 04:09:00 -05:00
| `MAVEN_CLI_OPTS` | `gemnasium-maven` | `"-DskipTests --batch-mode"` | List of command line arguments that are passed to `maven` by the analyzer. See an example for [using private repositories ](../index.md#using-private-maven-repositories ). |
| `GRADLE_CLI_OPTS` | `gemnasium-maven` | | List of command line arguments that are passed to `gradle` by the analyzer. |
| `SBT_CLI_OPTS` | `gemnasium-maven` | | List of command-line arguments that the analyzer passes to `sbt` . |
| `PIP_INDEX_URL` | `gemnasium-python` | `https://pypi.org/simple` | Base URL of Python Package Index. |
2021-06-16 23:09:59 -04:00
| `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. **Warning:** Please read [the following security consideration ](#python-projects ) when using this environment variable. |
2021-02-15 04:09:00 -05:00
| `PIP_REQUIREMENTS_FILE` | `gemnasium-python` | | Pip requirements file to be scanned. |
| `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, [removed ](https://www.python.org/doc/sunset-python-2/ ) in GitLab 13.7). |
| `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` 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` 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-11-07 16:06:14 -05:00
2021-02-10 22:09:06 -05:00
### Using a custom SSL CA certificate authority
2021-02-15 04:09:00 -05:00
You can use the `ADDITIONAL_CA_CERT_BUNDLE` CI/CD variable to configure a custom SSL CA certificate authority. The `ADDITIONAL_CA_CERT_BUNDLE` value should contain the [text representation of the X.509 PEM public-key certificate ](https://tools.ietf.org/html/rfc7468#section-5.1 ). For example, to configure this value in the `.gitlab-ci.yml` file, use the following:
2021-02-10 22:09:06 -05:00
```yaml
variables:
ADDITIONAL_CA_CERT_BUNDLE: |
-----BEGIN CERTIFICATE-----
MIIGqTCCBJGgAwIBAgIQI7AVxxVwg2kch4d56XNdDjANBgkqhkiG9w0BAQsFADCB
...
jWgmPqF3vUbZE0EyScetPJquRFRKIesyJuBFMAs=
-----END CERTIFICATE-----
```
2021-06-28 11:08:03 -04:00
The `ADDITIONAL_CA_CERT_BUNDLE` value can also be configured as a [custom variable in the UI ](../../../ci/variables/index.md#custom-cicd-variables ), either as a `file` , which requires the path to the certificate, or as a variable, which requires the text representation of the certificate.
2021-02-10 22:09:06 -05:00
2021-01-26 19:08:53 -05:00
### Using private Maven repositories
2019-11-07 16:06:14 -05:00
2020-05-05 23:09:33 -04:00
If your private Maven repository requires login credentials,
2021-02-15 04:09:00 -05:00
you can use the `MAVEN_CLI_OPTS` CI/CD variable.
2020-04-06 14:09:37 -04:00
2021-01-26 19:08:53 -05:00
Read more on [how to use private Maven repositories ](../index.md#using-private-maven-repositories ).
2019-06-07 06:48:46 -04:00
2019-09-10 06:06:45 -04:00
## Interacting with the vulnerabilities
Once a vulnerability is found, you can interact with it. Read more on how to
2021-04-29 20:10:28 -04:00
[address the vulnerabilities ](../vulnerabilities/index.md ).
2019-09-10 06:06:45 -04:00
2021-05-26 11:10:57 -04:00
## Solutions for vulnerabilities
2019-09-10 06:06:45 -04:00
Some vulnerabilities can be fixed by applying the solution that GitLab
2020-05-05 23:09:33 -04:00
automatically generates. Read more about the
2021-05-26 11:10:57 -04:00
[solutions for vulnerabilities ](../vulnerabilities/index.md#resolve-a-vulnerability ).
2019-09-10 06:06:45 -04:00
## 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
2021-04-29 11:10:07 -04:00
For more information about the vulnerabilities database update, see the
[maintenance table ](../vulnerabilities/index.md#vulnerability-scanner-maintenance ).
2019-09-10 06:06:45 -04:00
## Dependency List
2020-09-29 02:09:45 -04:00
An additional benefit of dependency scanning is the ability to view your
2019-09-10 06:06:45 -04:00
project's dependencies and their known vulnerabilities. Read more about
the [Dependency List ](../dependency_list/index.md ).
2019-06-12 07:11:00 -04:00
## Reports JSON format
2020-09-29 02:09:45 -04:00
The dependency scanning tool emits a JSON report file. For more information, see the
2020-06-15 14:08:43 -04:00
[schema for this report ](https://gitlab.com/gitlab-org/security-products/security-report-schemas/-/blob/master/dist/dependency-scanning-report-format.json ).
2019-06-12 07:11:00 -04:00
2020-09-29 02:09:45 -04:00
Here's an example dependency scanning report:
2019-06-12 07:11:00 -04:00
```json-doc
{
"version": "2.0",
"vulnerabilities": [
{
2020-04-09 17:09:19 -04:00
"id": "51e83874-0ff6-4677-a4c5-249060554eae",
2019-06-12 07:11:00 -04:00
"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-09 17:09:19 -04:00
"id": "5d681b13-e8fa-4668-957e-8d88f932ddc7",
2019-06-12 07:11:00 -04:00
"category": "dependency_scanning",
"name": "Authentication bypass via incorrect DOM traversal and canonicalization",
"message": "Authentication bypass via incorrect DOM traversal and canonicalization in saml2-js",
2020-08-09 17:10:01 -04:00
"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.",
2019-06-12 07:11:00 -04:00
"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-09 17:09:19 -04:00
"id": "5d681b13-e8fa-4668-957e-8d88f932ddc7",
2019-06-12 07:11:00 -04:00
}
],
"summary": "Upgrade saml2-js",
"diff": "ZGlmZiAtLWdpdCBhL...OR0d1ZUc2THh3UT09Cg==" // some content is omitted for brevity
}
]
}
```
2019-06-07 06:48:46 -04:00
## 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-06-05 14:40:31 -04:00
## 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.
2019-06-21 12:04:29 -04:00
You can also [submit new vulnerabilities ](https://gitlab.com/gitlab-org/security-products/gemnasium-db/blob/master/CONTRIBUTING.md ).
2019-07-25 10:16:25 -04:00
2020-09-29 02:09:45 -04:00
## Running dependency scanning in an offline environment
2020-04-21 11:21:10 -04:00
For self-managed GitLab instances in an environment with limited, restricted, or intermittent access
2020-09-29 02:09:45 -04:00
to external resources through the internet, some adjustments are required for dependency scanning
2020-05-06 14:09:38 -04:00
jobs to run successfully. For more information, see [Offline environments ](../offline_deployments/index.md ).
2020-04-21 11:21:10 -04:00
2020-09-29 02:09:45 -04:00
### Requirements for offline dependency scanning
2020-04-21 11:21:10 -04:00
2020-09-29 02:09:45 -04:00
Here are the requirements for using dependency scanning in an offline environment:
2020-04-21 11:21:10 -04:00
- GitLab Runner with the [`docker` or `kubernetes` executor ](#requirements ).
2020-09-29 02:09:45 -04:00
- Docker Container Registry with locally available copies of dependency scanning [analyzer ](https://gitlab.com/gitlab-org/security-products/analyzers ) images.
2020-11-19 13:09:13 -05:00
- If you have a limited access environment you need to allow access, such as using a proxy, to the advisory database: `https://gitlab.com/gitlab-org/security-products/gemnasium-db.git` .
2021-02-15 04:09:00 -05:00
If you are unable to permit access to `https://gitlab.com/gitlab-org/security-products/gemnasium-db.git` you must host an offline copy of this `git` repository and set the `GEMNASIUM_DB_REMOTE_URL` CI/CD variable to the URL of this repository. For more information on configuration variables, see [Dependency Scanning ](#configuring-dependency-scanning ).
2020-10-26 08:08:44 -04:00
2020-12-15 19:09:58 -05:00
This advisory database is constantly being updated, so you must periodically sync your local copy with GitLab.
2020-10-26 08:08:44 -04:00
2020-04-21 11:21:10 -04:00
- _Only if scanning Ruby projects_: Host an offline Git copy of the [advisory database ](https://github.com/rubysec/ruby-advisory-db ).
2021-01-26 19:08:53 -05:00
- _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.
2020-04-21 11:21:10 -04:00
2020-09-29 23:09:46 -04:00
Note that GitLab Runner has a [default `pull policy` of `always` ](https://docs.gitlab.com/runner/executors/docker.html#using-the-always-pull-policy ),
2020-09-14 23:09:24 -04:00
meaning the runner tries to pull Docker images from the GitLab container registry even if a local
copy is available. The GitLab Runner [`pull_policy` can be set to `if-not-present` ](https://docs.gitlab.com/runner/executors/docker.html#using-the-if-not-present-pull-policy )
2020-05-06 14:09:38 -04:00
in an offline environment if you prefer using only locally available Docker images. However, we
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-21 11:21:10 -04:00
2020-09-29 02:09:45 -04:00
### Make GitLab dependency scanning analyzer images available inside your Docker registry
2020-04-21 11:21:10 -04:00
2020-09-29 02:09:45 -04:00
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
2020-05-06 14:09:38 -04:00
your [local Docker container registry ](../../packages/container_registry/index.md ):
2020-04-21 11:21:10 -04:00
```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-05 23:09:33 -04:00
process by which external resources can be imported or temporarily accessed.
2021-04-29 11:10:07 -04:00
These scanners are [periodically updated ](../vulnerabilities/index.md#vulnerability-scanner-maintenance )
with new definitions, and you may be able to make occasional updates on your own.
2020-04-21 11:21:10 -04:00
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-10-13 17:09:27 -04:00
#### Support for Custom Certificate Authorities
Support for custom certificate authorities was introduced in the following versions.
| Analyzer | Version |
| -------- | ------- |
| `gemnasium` | [v2.8.0 ](https://gitlab.com/gitlab-org/security-products/analyzers/gemnasium/-/releases/v2.8.0 ) |
| `gemnasium-maven` | [v2.9.0 ](https://gitlab.com/gitlab-org/security-products/analyzers/gemnasium-maven/-/releases/v2.9.0 ) |
| `gemnasium-python` | [v2.7.0 ](https://gitlab.com/gitlab-org/security-products/analyzers/gemnasium-python/-/releases/v2.7.0 ) |
| `retire.js` | [v2.4.0 ](https://gitlab.com/gitlab-org/security-products/analyzers/retire.js/-/releases/v2.4.0 ) |
| `bundler-audit` | [v2.4.0 ](https://gitlab.com/gitlab-org/security-products/analyzers/bundler-audit/-/releases/v2.4.0 ) |
2021-02-15 04:09:00 -05:00
### Set dependency scanning CI/CD job variables to use local dependency scanning analyzers
2020-04-21 11:21:10 -04:00
2020-07-22 17:09:50 -04:00
Add the following configuration to your `.gitlab-ci.yml` file. You must change the value of
`SECURE_ANALYZERS_PREFIX` to refer to your local Docker container registry. You must also change the
value of `GEMNASIUM_DB_REMOTE_URL` to the location of your offline Git copy of the
[gemnasium-db advisory database ](https://gitlab.com/gitlab-org/security-products/gemnasium-db/ ):
2020-04-21 11:21:10 -04:00
```yaml
include:
2021-09-29 02:09:19 -04:00
- template: Security/Dependency-Scanning.gitlab-ci.yml
2020-04-21 11:21:10 -04:00
variables:
2020-06-17 17:08:24 -04:00
SECURE_ANALYZERS_PREFIX: "docker-registry.example.com/analyzers"
2020-05-18 14:08:22 -04:00
GEMNASIUM_DB_REMOTE_URL: "gitlab.example.com/gemnasium-db.git"
2020-04-21 11:21:10 -04:00
```
See explanations of the variables above in the [configuration section ](#configuration ).
### Specific settings for languages and package managers
2020-05-18 14:08:22 -04:00
See the following sections for configuring specific languages and package managers.
2020-04-21 11:21:10 -04:00
#### 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"
```
2021-01-26 19:08:53 -05:00
#### Python (setup tools)
2020-04-21 11:21:10 -04:00
2020-05-05 23:09:33 -04:00
When using self-signed certificates for your private PyPi repository, no extra job configuration (aside
2020-04-21 11:21:10 -04:00
from the template `.gitlab-ci.yml` above) is needed. However, you must update your `setup.py` to
2020-05-05 23:09:33 -04:00
ensure that it can reach your private repository. Here is an example configuration:
2020-04-21 11:21:10 -04:00
2020-05-05 23:09:33 -04:00
1. Update `setup.py` to create a `dependency_links` attribute pointing at your private repository for each
2020-04-21 11:21:10 -04:00
dependency in the `install_requires` list:
2020-05-20 23:08:00 -04:00
```python
install_requires=['pyparsing>=2.0.3'],
dependency_links=['https://pypi.example.com/simple/pyparsing'],
```
2020-04-21 11:21:10 -04:00
1. Fetch the certificate from your repository URL and add it to the project:
2020-05-20 23:08:00 -04:00
```shell
echo -n | openssl s_client -connect pypi.example.com:443 | sed -ne '/-BEGIN CERTIFICATE-/,/-END CERTIFICATE-/p' > internal.crt
```
2020-04-21 11:21:10 -04:00
1. Point `setup.py` at the newly downloaded certificate:
2020-05-20 23:08:00 -04:00
```python
import setuptools.ssl_support
setuptools.ssl_support.cert_paths = ['internal.crt']
```
2020-04-21 11:21:10 -04:00
2021-03-17 14:09:01 -04:00
## Hosting a copy of the gemnasium_db advisory database
2021-05-18 14:10:54 -04:00
The [`gemnasium_db` ](https://gitlab.com/gitlab-org/security-products/gemnasium-db ) Git repository is
2021-03-17 14:09:01 -04:00
used by `gemnasium` , `gemnasium-maven` , and `gemnasium-python` as the source of vulnerability data.
This repository updates at scan time to fetch the latest advisories. However, due to a restricted
networking environment, running this update is sometimes not possible. In this case, a user can do
one of the following:
- [Host a copy of the advisory database ](#host-a-copy-of-the-advisory-database )
- [Use a local clone ](#use-a-local-clone )
### Host a copy of the advisory database
If [gemnasium-db ](https://gitlab.com/gitlab-org/security-products/gemnasium-db ) is not reachable
from within the environment, the user can host their own Git copy. Then the analyzer can be
instructed to update the database from the user's copy by using `GEMNASIUM_DB_REMOTE_URL` :
```yaml
variables:
GEMNASIUM_DB_REMOTE_URL: https://users-own-copy.example.com/gemnasium-db/.git
...
```
### Use a local clone
If a hosted copy is not possible, then the user can clone [gemnasium-db ](https://gitlab.com/gitlab-org/security-products/gemnasium-db )
or create an archive before the scan and point the analyzer to the directory (using:
`GEMNASIUM_DB_LOCAL_PATH` ). Turn off the analyzer's self-update mechanism (using:
`GEMNASIUM_DB_UPDATE_DISABLED` ). In this example, the database directory is created in the
`before_script` , before the `gemnasium` analyzer's scan job:
```yaml
...
gemnasium-dependency_scanning:
variables:
GEMNASIUM_DB_LOCAL_PATH: ./gemnasium-db-local
GEMNASIUM_DB_UPDATE_DISABLED: "true"
before_script:
- mkdir $GEMNASIUM_DB_LOCAL_PATH
- tar -xzf gemnasium_db.tar.gz -C $GEMNASIUM_DB_LOCAL_PATH
```
2021-06-16 23:09:59 -04:00
## Warnings
### Python projects
Extra care needs to be taken when using the [`PIP_EXTRA_INDEX_URL` ](https://pipenv.pypa.io/en/latest/cli/#envvar-PIP_EXTRA_INDEX_URL )
environment variable due to a possible exploit documented by [CVE-2018-20225 ](https://nvd.nist.gov/vuln/detail/CVE-2018-20225 ):
> An issue was discovered in pip (all versions) because it installs the version with the highest version number, even if the user had
intended to obtain a private package from a private index. This only affects use of the `PIP_EXTRA_INDEX_URL` option, and exploitation
requires that the package does not already exist in the public index (and thus the attacker can put the package there with an arbitrary
version number).
2020-05-14 14:08:06 -04:00
## Limitations
### Referencing local dependencies using a path in JavaScript projects
2020-05-18 14:08:22 -04:00
The [Retire.js ](https://gitlab.com/gitlab-org/security-products/analyzers/retire.js ) analyzer
2021-03-09 13:09:41 -05:00
doesn't support dependency references made with [local paths ](https://docs.npmjs.com/cli/v6/configuring-npm/package-json/#local-paths )
2020-05-18 14:08:22 -04:00
in the `package.json` of JavaScript projects. The dependency scan outputs the following error for
such references:
2020-05-14 14:08:06 -04:00
2020-05-19 23:08:04 -04:00
```plaintext
2020-05-14 14:08:06 -04:00
ERROR: Could not find dependencies: < dependency-name > . You may need to run npm install
```
2021-05-17 17:10:42 -04:00
As a workaround, add the [`retire.js` ](analyzers.md ) analyzer to
[`DS_EXCLUDED_ANALYZERS` ](#configuring-dependency-scanning ).
2020-05-18 14:08:22 -04:00
2019-09-09 01:47:49 -04:00
## Troubleshooting
2019-07-25 10:16:25 -04:00
2021-04-27 23:09:58 -04:00
### Working around missing support for certain languages or package managers
As noted in the ["Supported languages" section ](#supported-languages-and-package-managers )
some dependency definition files are not yet supported.
However, Dependency Scanning can be achieved if
the language, a package manager, or a third-party tool
can convert the definition file
into a supported format.
Generally, the approach is the following:
1. Define a dedicated converter job in your `.gitlab-ci.yml` file.
Use a suitable Docker image, script, or both to facilitate the conversion.
1. Let that job upload the converted, supported file as an artifact.
2021-06-28 17:10:13 -04:00
1. Add [`dependencies: [< your-converter-job > ]`](../../../ci/yaml/index.md#dependencies)
2021-04-27 23:09:58 -04:00
to your `dependency_scanning` job to make use of the converted definitions files.
2021-08-06 14:09:57 -04:00
For example, the unsupported `poetry.lock` file can be
2021-04-27 23:09:58 -04:00
[converted ](https://python-poetry.org/docs/cli/#export )
to the supported `requirements.txt` as follows.
```yaml
include:
2021-09-29 02:09:19 -04:00
- template: Security/Dependency-Scanning.gitlab-ci.yml
2021-04-27 23:09:58 -04:00
stages:
- test
variables:
PIP_REQUIREMENTS_FILE: "requirements-converted.txt"
2021-08-04 20:08:57 -04:00
gemnasium-python-dependency_scanning:
# Work around https://gitlab.com/gitlab-org/gitlab/-/issues/7006
before_script:
2021-04-27 23:09:58 -04:00
- pip install poetry # Or via another method: https://python-poetry.org/docs/#installation
2021-08-04 20:08:57 -04:00
- poetry export --output="$PIP_REQUIREMENTS_FILE"
- rm poetry.lock pyproject.toml
2021-04-27 23:09:58 -04:00
```
2020-05-27 05:08:30 -04:00
### `Error response from daemon: error processing tar file: docker-tar: relocation error`
2019-07-25 10:16:25 -04:00
2021-01-06 16:10:18 -05:00
This error occurs when the Docker version that runs the dependency scanning job is `19.03.0` .
2020-05-05 23:09:33 -04:00
Consider updating to Docker `19.03.1` or greater. Older versions are not
2019-09-09 01:47:49 -04:00
affected. Read more in
2020-05-21 23:08:28 -04:00
[this issue ](https://gitlab.com/gitlab-org/gitlab/-/issues/13830#note_211354992 "Current SAST container fails" ).
2020-09-28 14:09:40 -04:00
2020-09-29 14:09:52 -04:00
### Getting warning message `gl-dependency-scanning-report.json: no matching files`
For information on this, see the [general Application Security troubleshooting section ](../../../ci/pipelines/job_artifacts.md#error-message-no-files-to-upload ).
2020-09-28 14:09:40 -04:00
### Limitation when using rules:exists
2020-09-29 02:09:45 -04:00
The [dependency scanning CI template ](https://gitlab.com/gitlab-org/gitlab/-/blob/master/lib/gitlab/ci/templates/Security/Dependency-Scanning.gitlab-ci.yml )
2021-06-28 17:10:13 -04:00
uses the [`rules:exists` ](../../../ci/yaml/index.md#rulesexists )
2020-09-28 14:09:40 -04:00
syntax. This directive is limited to 10000 checks and always returns `true` after reaching this
2020-09-29 02:09:45 -04:00
number. Because of this, and depending on the number of files in your repository, a dependency
scanning job might be triggered even if the scanner doesn't support your project.
2020-12-16 16:09:57 -05:00
### Issues building projects with npm or yarn packages relying on Python 2
2021-01-26 19:08:53 -05:00
[Python 2 was removed ](https://www.python.org/doc/sunset-python-2/ ) from the `retire.js` analyzer in GitLab 13.7 (analyzer version 2.10.1). Projects using packages
2020-12-16 16:09:57 -05:00
with a dependency on this version of Python should use `retire.js` version 2.10.0 or lower (for example, `registry.gitlab.com/gitlab-org/security-products/analyzers/retire.js:2.10.0` ).
2021-01-31 19:09:19 -05:00
### Error: `dependency_scanning is used for configuration only, and its script should not be executed`
For information on this, see the [GitLab Secure troubleshooting section ](../index.md#error-job-is-used-for-configuration-only-and-its-script-should-not-be-executed ).
2021-09-05 23:11:02 -04:00
### Import multiple certificates for Java-based projects
The `gemnasium-maven` analyzer reads the contents of the `ADDITIONAL_CA_CERT_BUNDLE` variable using `keytool` , which imports either a single certificate or a certificate chain. Multiple unrelated certificates are ignored and only the first one is imported by `keytool` .
To add multiple unrelated certificates to the analyzer, you can declare a `before_script` such as this in the definition of the `gemnasium-maven-dependency_scanning` job:
```yaml
gemnasium-maven-dependency_scanning:
before_script:
- . $HOME/.bashrc # make the java tools available to the script
- OIFS="$IFS"; IFS=""; echo $ADDITIONAL_CA_CERT_BUNDLE > multi.pem; IFS="$OIFS" # write ADDITIONAL_CA_CERT_BUNDLE variable to a PEM file
- csplit -z --digits=2 --prefix=cert multi.pem "/-----END CERTIFICATE-----/+1" "{*}" # split the file into individual certificates
- for i in `ls cert*` ; do keytool -v -importcert -alias "custom-cert-$i" -file $i -trustcacerts -noprompt -storepass changeit -keystore /opt/asdf/installs/java/adoptopenjdk-11.0.7+10.1/lib/security/cacerts 1>/dev/null 2>& 1 || true; done # import each certificate using keytool (note the keystore location is related to the Java version being used and should be changed accordingly for other versions)
- unset ADDITIONAL_CA_CERT_BUNDLE # unset the variable so that the analyzer doesn't duplicate the import
```
2021-10-13 14:12:40 -04:00
### Dependency Scanning job fails with message `strconv.ParseUint: parsing "0.0": invalid syntax`
Invoking Docker-in-Docker is the likely cause of this error. Docker-in-Docker is:
- Disabled by default in GitLab 13.0 and later.
- Unsupported from GitLab 13.4 and later.
To fix this error, disable Docker-in-Docker for dependency scanning. Individual
`<analyzer-name>-dependency_scanning` jobs are created for each analyzer that runs in your CI/CD
pipeline.
```yaml
include:
- template: Dependency-Scanning.gitlab-ci.yml
variables:
DS_DISABLE_DIND: "true"
```
2021-10-18 11:12:11 -04:00
### Message `<file> does not exist in <commit SHA>`
When the `Location` of a dependency in a file is shown, the path in the link goes to a specific Git
SHA.
If the lock file that our dependency scanning tools reviewed was cached, however, selecting that
link redirects you to the repository root, with the message:
`<file> does not exist in <commit SHA>` .
The lock file is cached during the build phase and passed to the dependency scanning job before the
scan occurs. Because the cache is downloaded before the analyzer run occurs, the existence of a lock
file in the `CI_BUILDS_DIR` directory triggers the dependency scanning job.
We recommend committing the lock files, which prevents this warning.
