Dependency Scanning Analyzers
Dependency Scanning supports the following official analyzers:
The analyzers are published as Docker images, which Dependency Scanning uses to launch dedicated containers for each analysis.
Dependency Scanning is pre-configured with a set of default images that are maintained by GitLab, but users can also integrate their own custom images.
Official default analyzers
Any custom change to the official analyzers can be achieved by using a
CI/CD variable in your .gitlab-ci.yml
.
Using a custom Docker mirror
You can switch to a custom Docker registry that provides the official analyzer
images under a different prefix. For instance, the following instructs Dependency
Scanning to pull my-docker-registry/gl-images/gemnasium
instead of registry.gitlab.com/security-products/gemnasium
.
In .gitlab-ci.yml
define:
include:
template: Security/Dependency-Scanning.gitlab-ci.yml
variables:
SECURE_ANALYZERS_PREFIX: my-docker-registry/gl-images
This configuration requires that your custom registry provides images for all the official analyzers.
Disable specific analyzers
You can select the official analyzers you don’t want to run. Here’s how to disable
the gemnasium
analyzer.
In .gitlab-ci.yml
define:
include:
template: Security/Dependency-Scanning.gitlab-ci.yml
variables:
DS_EXCLUDED_ANALYZERS: "gemnasium"
Disabling default analyzers
Setting DS_EXCLUDED_ANALYZERS
to a list of the official analyzers disables them.
In .gitlab-ci.yml
define:
include:
template: Security/Dependency-Scanning.gitlab-ci.yml
variables:
DS_EXCLUDED_ANALYZERS: "gemnasium, gemnasium-maven, gemnasium-python"
This is used when one totally relies on custom analyzers.
Custom analyzers
You can provide your own analyzers by
defining CI jobs in your CI configuration. For consistency, you should suffix your custom Dependency
Scanning jobs with -dependency_scanning
. Here’s how to add a scanning job that’s based on the
Docker image my-docker-registry/analyzers/nuget
and generates a Dependency Scanning report
gl-dependency-scanning-report.json
when /analyzer run
is executed. Define the following in
.gitlab-ci.yml
:
nuget-dependency_scanning:
image:
name: "my-docker-registry/analyzers/nuget"
script:
- /analyzer run
artifacts:
reports:
dependency_scanning: gl-dependency-scanning-report.json
The Security Scanner Integration documentation explains how to integrate custom security scanners into GitLab.
Analyzers data
The following table lists the data available for the Gemnasium analyzer.
Property \ Tool | Gemnasium |
---|---|
Severity | ✓ |
Title | ✓ |
File | ✓ |
Start line | 𐄂 |
End line | 𐄂 |
External ID (for example, CVE) | ✓ |
URLs | ✓ |
Internal doc/explanation | ✓ |
Solution | ✓ |
Confidence | 𐄂 |
Affected item (for example, class or package) | ✓ |
Source code extract | 𐄂 |
Internal ID | ✓ |
Date | ✓ |
Credits | ✓ |
- ✓ => we have that data
- ⚠ => we have that data, but it’s partially reliable, or we need to extract that data from unstructured content
- 𐄂 => we don’t have that data, or it would need to develop specific or inefficient/unreliable logic to obtain it.
The values provided by these tools are heterogeneous, so they are sometimes
normalized into common values (for example, severity
, confidence
, etc).