Dependency Scanning (ULTIMATE)

Introduced in GitLab Ultimate 10.7.

Dependency Scanning helps to automatically find security vulnerabilities in your dependencies while you're developing and testing your applications, such as when your application is using an external (open source) library which is known to be vulnerable.

Overview

If you're using GitLab CI/CD, you can analyze your dependencies for known vulnerabilities using Dependency Scanning. All dependencies are scanned, including the transitive dependencies (also known as nested dependencies). You can take advantage of Dependency Scanning by either including the Dependency Scanning template in your existing .gitlab-ci.yml file or by implicitly using the Auto Dependency Scanning provided by Auto DevOps.

GitLab checks the Dependency Scanning report, compares the found vulnerabilities between the source and target branches, and shows the information on the merge request.

Dependency Scanning Widget

The results are sorted by the severity of the vulnerability:

  1. Critical
  2. High
  3. Medium
  4. Low
  5. Unknown
  6. Everything else

Requirements

To run Dependency Scanning jobs, by default, you need GitLab Runner with the docker or kubernetes executor. If you're using the shared Runners on GitLab.com, this is enabled by default.

CAUTION: Caution: If you use your own Runners, make sure your installed version of Docker is not 19.03.0. See troubleshooting information for details.

Beginning with GitLab 13.0, Docker privileged mode is necessary only if you've enabled Docker-in-Docker for Dependency Scanning.

Supported languages and package managers

GitLab relies on 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, Maven) build.gradle, build.gradle.kts, pom.xml Gemnasium
JavaScript (npm, yarn) package-lock.json, npm-shrinkwrap.json, yarn.lock Gemnasium, Retire.js
Go (Golang) go.sum Gemnasium
PHP (Composer) composer.lock Gemnasium
Python (setuptools, pip, Pipenv) setup.py, requirements.txt, requirements.pip, requires.txt, Pipfile Gemnasium
Ruby (Bundler) Gemfile.lock, gems.locked Gemnasium, bundler-audit
Scala (sbt) build.sbt 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) poetry.lock Gemnasium GitLab#7006
Python (Pipenv) Pipfile.lock Gemnasium GitLab#11756

Contribute your scanner

The Security Scanner Integration documentation explains how to integrate other security scanners into GitLab.

Configuration

To enable Dependency Scanning for GitLab 11.9 and later, you must include the Dependency-Scanning.gitlab-ci.yml template 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.

Add the following to your .gitlab-ci.yml file:

include:
  - template: Dependency-Scanning.gitlab-ci.yml

The included template will create Dependency Scanning jobs in your CI/CD pipeline and scan your project's source code for possible vulnerabilities. The results will be saved as a Dependency Scanning report artifact that you can later download and analyze. Due to implementation limitations, we always take the latest Dependency Scanning artifact available.

Customizing the Dependency Scanning settings

The Dependency Scanning settings can be changed through environment variables by using the variables parameter in .gitlab-ci.yml. For example:

include:
  - template: Dependency-Scanning.gitlab-ci.yml

variables:
  DS_PYTHON_VERSION: 2

Because template is evaluated before the pipeline configuration, the last mention of the variable will take precedence.

Overriding Dependency Scanning jobs

CAUTION: Deprecation: Beginning in GitLab 13.0, the use of only and except is no longer supported. When overriding the template, you must use rules instead.

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:

include:
  - template: Dependency-Scanning.gitlab-ci.yml

gemnasium-dependency_scanning:
  variables:
    DS_REMEDIATE: "false"

Available variables

Dependency Scanning can be configured using environment variables.

Configuring Dependency Scanning

The following variables allow configuration of global dependency scanning settings.

Environment variable Description
SECURE_ANALYZERS_PREFIX Override the name of the Docker registry providing the official default images (proxy). Read more about customizing analyzers.
DS_DEFAULT_ANALYZERS Override the names of the official default images. Read more about customizing analyzers.
DS_DISABLE_DIND Disable Docker-in-Docker and run analyzers individually. This variable is true by default.
ADDITIONAL_CA_CERT_BUNDLE Bundle of CA certs to trust.
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_LOG_LEVEL Default log level is info, you can set it to any of the following strings: fatal, error, warn, info, debug.

Configuring Docker-in-Docker orchestrator

The following variables configure the Docker-in-Docker orchestrator, and therefore are only used when the Docker-in-Docker mode is enabled.

Environment variable Default Description
DS_ANALYZER_IMAGES Comma-separated list of custom images. The official default images are still enabled. Read more about customizing analyzers.
DS_ANALYZER_IMAGE_TAG Override the Docker tag of the official default images. Read more about customizing analyzers.
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. 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. 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. 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
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.
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.
PIP_INDEX_URL gemnasium-python https://pypi.org/simple Base URL of Python Package Index.
PIP_EXTRA_INDEX_URL gemnasium-python Array of extra URLs of package indexes to use in addition to PIP_INDEX_URL. Comma-separated.
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 in GitLab 12.7)
DS_PIP_DEPENDENCY_PATH gemnasium-python Path to load Python pip dependencies from. (Introduced 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 in GitLab 12.1)
DS_JAVA_VERSION gemnasium-maven 11 Version of Java. Available versions: 8, 11, 13, 14. Maven and Gradle will use the Java version specified by this value.
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.
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.
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.
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.

Using private Maven repos

If your private Maven repository requires login credentials, you can use the MAVEN_CLI_OPTS environment variable.

Read more on how to use private Maven repositories.

Enabling Docker-in-Docker

Introduced in GitLab Ultimate 12.5.

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:

  1. Configure GitLab Runner with Docker-in-Docker in privileged mode.

  2. Set the DS_DISABLE_DIND variable to false:

    include:
      - template: Dependency-Scanning.gitlab-ci.yml
    
    variables:
      DS_DISABLE_DIND: "false"

This creates a single dependency_scanning job in your CI/CD pipeline instead of multiple <analyzer-name>-dependency_scanning jobs.

Interacting with the vulnerabilities

Once a vulnerability is found, you can interact with it. Read more on how to interact with the vulnerabilities.

Solutions for vulnerabilities (auto-remediation)

Some vulnerabilities can be fixed by applying the solution that GitLab automatically generates. Read more about the solutions for vulnerabilities.

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.

Vulnerabilities database update

For more information about the vulnerabilities database update, check the maintenance table.

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.

Reports JSON format

The Dependency Scanning tool emits a JSON report file. For more information, see the schema for this report.

Here's an example Dependency Scanning report:

{
  "version": "2.0",
  "vulnerabilities": [
    {
      "id": "51e83874-0ff6-4677-a4c5-249060554eae",
      "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"
        }
      ]
    },
    {
      "id": "5d681b13-e8fa-4668-957e-8d88f932ddc7",
      "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": [
        {
          "id": "5d681b13-e8fa-4668-957e-8d88f932ddc7",
        }
      ],
      "summary": "Upgrade saml2-js",
      "diff": "ZGlmZiAtLWdpdCBhL...OR0d1ZUc2THh3UT09Cg==" // some content is omitted for brevity
    }
  ]
}

Versioning and release process

Please check the Release Process documentation.

Contributing to the vulnerability database

You can search the gemnasium-db project to find a vulnerability in the Gemnasium database. You can also submit new vulnerabilities.

Running Dependency Scanning in an offline environment

For self-managed GitLab instances in an environment with limited, restricted, or intermittent access to external resources through the internet, some adjustments are required for Dependency Scanning jobs to run successfully. For more information, see Offline environments.

Requirements for offline Dependency Scanning

Here are the requirements for using Dependency Scanning in an offline environment:

NOTE: Note: GitLab Runner has a default pull policy of always, meaning the Runner tries to pull Docker images from the GitLab container registry even if a local copy is available. GitLab Runner's pull_policy can be set to if-not-present 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.

Make GitLab Dependency Scanning analyzer images available inside your Docker registry

For Dependency Scanning with all supported languages and frameworks, import the following default Dependency Scanning analyzer images from registry.gitlab.com into your local Docker container registry:

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 process by which external resources can be imported or temporarily accessed. Note that these scanners are updated periodically with new definitions, so consider if you can make periodic updates yourself.

For details on saving and transporting Docker images as a file, see Docker's documentation on docker save, docker load, docker export, and docker import.

Set Dependency Scanning CI job variables to use local Dependency Scanning analyzers

Add the following configuration to your .gitlab-ci.yml file. You must replace SECURE_ANALYZERS_PREFIX to refer to your local Docker container registry:

include:
  - template: Dependency-Scanning.gitlab-ci.yml

variables:
  SECURE_ANALYZERS_PREFIX: "docker-registry.example.com/analyzers"
  GEMNASIUM_DB_REMOTE_URL: "gitlab.example.com/gemnasium-db.git"
  GIT_SSL_NO_VERIFY: "true"

See explanations of the variables above in the configuration section.

Specific settings for languages and package managers

See the following sections for configuring specific languages and package managers.

JavaScript (npm and yarn) projects

Add the following to the variables section of .gitlab-ci.yml:

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:

BUNDLER_AUDIT_ADVISORY_DB_REF_NAME: "master"
BUNDLER_AUDIT_ADVISORY_DB_URL: "gitlab.example.com/ruby-advisory-db.git"

Python (setuptools)

When using self-signed certificates for your private PyPi repository, no extra job configuration (aside from the template .gitlab-ci.yml above) is needed. However, you must update your setup.py to ensure that it can reach your private repository. Here is an example configuration:

  1. Update setup.py to create a dependency_links attribute pointing at your private repository for each dependency in the install_requires list:

    install_requires=['pyparsing>=2.0.3'],
    dependency_links=['https://pypi.example.com/simple/pyparsing'],
  2. Fetch the certificate from your repository URL and add it to the project:

    echo -n | openssl s_client -connect pypi.example.com:443 | sed -ne '/-BEGIN CERTIFICATE-/,/-END CERTIFICATE-/p' > internal.crt
  3. Point setup.py at the newly downloaded certificate:

    import setuptools.ssl_support
    setuptools.ssl_support.cert_paths = ['internal.crt']

Limitations

Referencing local dependencies using a path in JavaScript projects

The Retire.js analyzer doesn't support dependency references made with local paths in the package.json of JavaScript projects. The dependency scan outputs the following error for such references:

ERROR: Could not find dependencies: <dependency-name>. You may need to run npm install

As a workaround, remove the retire.js analyzer from DS_DEFAULT_ANALYZERS.

Troubleshooting

Error response from daemon: error processing tar file: docker-tar: relocation error

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 affected. Read more in this issue.