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

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

138 lines
5.3 KiB
Markdown
Raw Normal View History

2020-07-28 23:09:34 +05:30
---
type: reference, howto
stage: Secure
group: Composition Analysis
2022-11-25 23:54:43 +05:30
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/product/ux/technical-writing/#assignments
2020-07-28 23:09:34 +05:30
---
2019-09-30 21:07:59 +05:30
# Dependency Scanning Analyzers **(ULTIMATE)**
2020-10-24 23:57:45 +05:30
Dependency Scanning relies on underlying third-party tools that are wrapped into
2019-09-30 21:07:59 +05:30
what we call "Analyzers". An analyzer is a
[dedicated project](https://gitlab.com/gitlab-org/security-products/analyzers)
that wraps a particular tool to:
- Expose its detection logic.
- Handle its execution.
- Convert its output to the common format.
This is achieved by implementing the [common API](https://gitlab.com/gitlab-org/security-products/analyzers/common).
Dependency Scanning supports the following official analyzers:
- [`gemnasium`](https://gitlab.com/gitlab-org/security-products/analyzers/gemnasium)
- [`gemnasium-maven`](https://gitlab.com/gitlab-org/security-products/analyzers/gemnasium-maven)
- [`gemnasium-python`](https://gitlab.com/gitlab-org/security-products/analyzers/gemnasium-python)
2020-10-24 23:57:45 +05:30
The analyzers are published as Docker images, which Dependency Scanning uses
2019-09-30 21:07:59 +05:30
to launch dedicated containers for each analysis.
2022-04-04 11:22:00 +05:30
The Dependency Scanning analyzers' current major version number is 2.
2019-09-30 21:07:59 +05:30
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
2021-03-11 19:13:27 +05:30
Any custom change to the official analyzers can be achieved by using a
[CI/CD variable in your `.gitlab-ci.yml`](index.md#customizing-the-dependency-scanning-settings).
2019-09-30 21:07:59 +05:30
### 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`
2022-05-07 20:08:51 +05:30
instead of `registry.gitlab.com/security-products/gemnasium`.
2019-09-30 21:07:59 +05:30
In `.gitlab-ci.yml` define:
```yaml
include:
2021-11-18 22:05:49 +05:30
template: Security/Dependency-Scanning.gitlab-ci.yml
2019-09-30 21:07:59 +05:30
variables:
2020-05-24 23:13:21 +05:30
SECURE_ANALYZERS_PREFIX: my-docker-registry/gl-images
2019-09-30 21:07:59 +05:30
```
This configuration requires that your custom registry provides images for all
the official analyzers.
2021-06-08 01:23:25 +05:30
### Disable specific analyzers
2019-09-30 21:07:59 +05:30
2021-06-08 01:23:25 +05:30
You can select the official analyzers you don't want to run. Here's how to disable
2022-07-16 23:28:13 +05:30
the `gemnasium` analyzer.
2019-09-30 21:07:59 +05:30
In `.gitlab-ci.yml` define:
```yaml
include:
2021-11-18 22:05:49 +05:30
template: Security/Dependency-Scanning.gitlab-ci.yml
2019-09-30 21:07:59 +05:30
variables:
2022-07-16 23:28:13 +05:30
DS_EXCLUDED_ANALYZERS: "gemnasium"
2019-09-30 21:07:59 +05:30
```
### Disabling default analyzers
2021-06-08 01:23:25 +05:30
Setting `DS_EXCLUDED_ANALYZERS` to a list of the official analyzers disables them.
In `.gitlab-ci.yml` define:
2019-09-30 21:07:59 +05:30
```yaml
include:
2021-11-18 22:05:49 +05:30
template: Security/Dependency-Scanning.gitlab-ci.yml
2019-09-30 21:07:59 +05:30
variables:
2022-07-16 23:28:13 +05:30
DS_EXCLUDED_ANALYZERS: "gemnasium, gemnasium-maven, gemnasium-python"
2019-09-30 21:07:59 +05:30
```
2021-06-08 01:23:25 +05:30
This is used when one totally relies on [custom analyzers](#custom-analyzers).
2019-09-30 21:07:59 +05:30
## Custom analyzers
2020-11-24 15:15:51 +05:30
You can provide your own analyzers by
2020-04-22 19:07:51 +05:30
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`:
```yaml
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](../../../development/integrations/secure.md) documentation explains how to integrate custom security scanners into GitLab.
2019-09-30 21:07:59 +05:30
## Analyzers data
2022-07-16 23:28:13 +05:30
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 | ✓ |
2019-09-30 21:07:59 +05:30
- ✓ => we have that data
2020-10-24 23:57:45 +05:30
- ⚠ => 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.
2019-09-30 21:07:59 +05:30
2020-10-24 23:57:45 +05:30
The values provided by these tools are heterogeneous, so they are sometimes
2022-01-26 12:08:38 +05:30
normalized into common values (for example, `severity`, `confidence`, etc).