2019-10-12 21:52:04 +05:30
---
2020-06-23 00:09:42 +05:30
stage: Secure
group: Static Analysis
2021-02-22 17:27:13 +05:30
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-10-12 21:52:04 +05:30
type: reference, howto
---
2021-04-17 20:07:23 +05:30
# Static Application Security Testing (SAST) **(FREE)**
2019-07-31 22:56:46 +05:30
2021-12-11 22:18:48 +05:30
> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/3775) in GitLab 10.3.
> - All open source (OSS) analyzers were moved from GitLab Ultimate to GitLab Free in GitLab 13.3.
2019-07-31 22:56:46 +05:30
2021-02-22 17:27:13 +05:30
NOTE:
2020-07-28 23:09:34 +05:30
The whitepaper ["A Seismic Shift in Application Security" ](https://about.gitlab.com/resources/whitepaper-seismic-shift-application-security/ )
2021-01-03 14:25:43 +05:30
explains how 4 of the top 6 attacks were application based. Download it to learn how to protect your
organization.
2019-07-31 22:56:46 +05:30
2021-09-30 23:02:18 +05:30
If you're using [GitLab CI/CD ](../../../ci/index.md ), you can use Static Application Security
2021-12-11 22:18:48 +05:30
Testing (SAST) to check your source code for known vulnerabilities.
If the pipeline is associated with a merge request, the SAST analysis is compared with the results of
2021-09-30 23:02:18 +05:30
the target branch's analysis (if available). The results of that comparison are shown in the merge
2021-12-11 22:18:48 +05:30
request. If the pipeline is running from the default branch, the results of the SAST
2021-09-30 23:02:18 +05:30
analysis are available in the [security dashboards ](../security_dashboard/index.md ).
2019-07-31 22:56:46 +05:30
2021-09-30 23:02:18 +05:30
2019-07-31 22:56:46 +05:30
The results are sorted by the priority of the vulnerability:
2021-11-18 22:05:49 +05:30
<!-- vale gitlab.SubstitutionWarning = NO -->
2019-07-31 22:56:46 +05:30
1. Critical
1. High
1. Medium
1. Low
2021-10-27 15:23:28 +05:30
1. Info
2019-07-31 22:56:46 +05:30
1. Unknown
2021-11-18 22:05:49 +05:30
<!-- vale gitlab.SubstitutionWarning = YES -->
2021-01-03 14:25:43 +05:30
A pipeline consists of multiple jobs, including SAST and DAST scanning. If any job fails to finish
2021-01-29 00:20:46 +05:30
for any reason, the security dashboard does not show SAST scanner output. For example, if the SAST
job finishes but the DAST job fails, the security dashboard does not show SAST results. On failure,
2021-01-03 14:25:43 +05:30
the analyzer outputs an [exit code ](../../../development/integrations/secure.md#exit-code ).
2020-05-24 23:13:21 +05:30
2019-07-31 22:56:46 +05:30
## Use cases
- Your code has a potentially dangerous attribute in a class, or unsafe code
that can lead to unintended code execution.
- Your application is vulnerable to cross-site scripting (XSS) attacks that can
be leveraged to unauthorized access to session data.
## Requirements
2020-11-24 15:15:51 +05:30
To run SAST jobs, by default, you need GitLab Runner with the
2020-05-24 23:13:21 +05:30
[`docker` ](https://docs.gitlab.com/runner/executors/docker.html ) or
[`kubernetes` ](https://docs.gitlab.com/runner/install/kubernetes.html ) executor.
2020-11-24 15:15:51 +05:30
If you're using the shared runners on GitLab.com, this is enabled by default.
2019-12-21 20:55:43 +05:30
2021-02-22 17:27:13 +05:30
WARNING:
2020-10-24 23:57:45 +05:30
Our SAST jobs require a Linux container type. Windows containers are not yet supported.
2020-03-13 15:44:24 +05:30
2021-02-22 17:27:13 +05:30
WARNING:
2020-11-24 15:15:51 +05:30
If you use your own runners, make sure the Docker version installed
2020-04-22 19:07:51 +05:30
is **not** `19.03.0` . See [troubleshooting information ](#error-response-from-daemon-error-processing-tar-file-docker-tar-relocation-error ) for details.
2019-12-04 20:38:33 +05:30
2019-07-31 22:56:46 +05:30
## Supported languages and frameworks
2021-02-22 17:27:13 +05:30
GitLab SAST supports a variety of languages, package managers, and frameworks. Our SAST security scanners also feature automatic language detection which works even for mixed-language projects. If any supported language is detected in project source code we automatically run the appropriate SAST analyzers.
2020-11-24 15:15:51 +05:30
2021-01-03 14:25:43 +05:30
You can also [view our language roadmap ](https://about.gitlab.com/direction/secure/static-analysis/sast/#language-support ) and [request other language support by opening an issue ](https://gitlab.com/groups/gitlab-org/-/epics/297 ).
2019-07-31 22:56:46 +05:30
2021-04-29 21:17:54 +05:30
| Language (package managers) / framework | Scan tool | Introduced in GitLab Version |
|---------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------|
| .NET Core | [Security Code Scan ](https://security-code-scan.github.io ) | 11.0 |
| .NET Framework | [Security Code Scan ](https://security-code-scan.github.io ) | 13.0 |
| Apex (Salesforce) | [PMD ](https://pmd.github.io/pmd/index.html ) | 12.1 |
2021-11-18 22:05:49 +05:30
| C | [Semgrep ](https://semgrep.dev ) | 14.2 |
2021-04-29 21:17:54 +05:30
| C/C++ | [Flawfinder ](https://github.com/david-a-wheeler/flawfinder ) | 10.7 |
| Elixir (Phoenix) | [Sobelow ](https://github.com/nccgroup/sobelow ) | 11.1 |
| Go | [Gosec ](https://github.com/securego/gosec ) | 10.7 |
2021-11-18 22:05:49 +05:30
| Go | [Semgrep ](https://semgrep.dev ) | 14.4 |
2021-04-29 21:17:54 +05:30
| Groovy ([Ant](https://ant.apache.org/), [Gradle ](https://gradle.org/ ), [Maven ](https://maven.apache.org/ ), and [SBT ](https://www.scala-sbt.org/ )) | [SpotBugs ](https://spotbugs.github.io/ ) with the [find-sec-bugs ](https://find-sec-bugs.github.io/ ) plugin | 11.3 (Gradle) & 11.9 (Ant, Maven, SBT) |
| Helm Charts | [Kubesec ](https://github.com/controlplaneio/kubesec ) | 13.1 |
| Java ([Ant](https://ant.apache.org/), [Gradle ](https://gradle.org/ ), [Maven ](https://maven.apache.org/ ), and [SBT ](https://www.scala-sbt.org/ )) | [SpotBugs ](https://spotbugs.github.io/ ) with the [find-sec-bugs ](https://find-sec-bugs.github.io/ ) plugin | 10.6 (Maven), 10.8 (Gradle) & 11.9 (Ant, SBT) |
| Java (Android) | [MobSF (beta) ](https://github.com/MobSF/Mobile-Security-Framework-MobSF ) | 13.5 |
| JavaScript | [ESLint security plugin ](https://github.com/nodesecurity/eslint-plugin-security ) | 11.8 |
| JavaScript | [Semgrep ](https://semgrep.dev ) | 13.10 |
| Kotlin (Android) | [MobSF (beta) ](https://github.com/MobSF/Mobile-Security-Framework-MobSF ) | 13.5 |
| Kotlin (General) | [SpotBugs ](https://spotbugs.github.io/ ) with the [find-sec-bugs ](https://find-sec-bugs.github.io/ ) plugin | 13.11 |
| Kubernetes manifests | [Kubesec ](https://github.com/controlplaneio/kubesec ) | 12.6 |
| Node.js | [NodeJsScan ](https://github.com/ajinabraham/NodeJsScan ) | 11.1 |
| Objective-C (iOS) | [MobSF (beta) ](https://github.com/MobSF/Mobile-Security-Framework-MobSF ) | 13.5 |
| PHP | [phpcs-security-audit ](https://github.com/FloeDesignTechnologies/phpcs-security-audit ) | 10.8 |
| Python ([pip](https://pip.pypa.io/en/stable/)) | [bandit ](https://github.com/PyCQA/bandit ) | 10.3 |
| Python | [Semgrep ](https://semgrep.dev ) | 13.9 |
| React | [ESLint react plugin ](https://github.com/yannickcr/eslint-plugin-react ) | 12.5 |
| React | [Semgrep ](https://semgrep.dev ) | 13.10 |
| Ruby | [brakeman ](https://brakemanscanner.org ) | 13.9 |
| Ruby on Rails | [brakeman ](https://brakemanscanner.org ) | 10.3 |
| Scala ([Ant](https://ant.apache.org/), [Gradle ](https://gradle.org/ ), [Maven ](https://maven.apache.org/ ), and [SBT ](https://www.scala-sbt.org/ )) | [SpotBugs ](https://spotbugs.github.io/ ) with the [find-sec-bugs ](https://find-sec-bugs.github.io/ ) plugin | 11.0 (SBT) & 11.9 (Ant, Gradle, Maven) |
| Swift (iOS) | [MobSF (beta) ](https://github.com/MobSF/Mobile-Security-Framework-MobSF ) | 13.5 |
| TypeScript | [ESLint security plugin ](https://github.com/nodesecurity/eslint-plugin-security ) | 11.9, [merged ](https://gitlab.com/gitlab-org/gitlab/-/issues/36059 ) with ESLint in 13.2 |
| TypeScript | [Semgrep ](https://semgrep.dev ) | 13.10 |
2019-07-31 22:56:46 +05:30
2021-01-03 14:25:43 +05:30
Note that the Java analyzers can also be used for variants like the
2019-07-31 22:56:46 +05:30
[Gradle wrapper ](https://docs.gradle.org/current/userguide/gradle_wrapper.html ),
2021-01-03 14:25:43 +05:30
[Grails ](https://grails.org/ ),
and the [Maven wrapper ](https://github.com/takari/maven-wrapper ).
2019-07-31 22:56:46 +05:30
2021-02-22 17:27:13 +05:30
### Multi-project support
> [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/4895) in GitLab 13.7.
2021-04-17 20:07:23 +05:30
GitLab SAST can scan repositories that contain multiple projects.
2021-02-22 17:27:13 +05:30
The following analyzers have multi-project support:
- Bandit
- ESLint
- Gosec
- Kubesec
- NodeJsScan
- MobSF
- PMD
- Security Code Scan
2021-03-11 19:13:27 +05:30
- Semgrep
2021-02-22 17:27:13 +05:30
- SpotBugs
- Sobelow
#### Enable multi-project support for Security Code Scan
Multi-project support in the Security Code Scan requires a Solution (`.sln`) file in the root of
2021-03-11 19:13:27 +05:30
the repository. For details on the Solution format, see the Microsoft reference [Solution (`.sln`) file ](https://docs.microsoft.com/en-us/visualstudio/extensibility/internals/solution-dot-sln-file?view=vs-2019 ).
2021-02-22 17:27:13 +05:30
2020-07-28 23:09:34 +05:30
### Making SAST analyzers available to all GitLab tiers
2021-03-11 19:13:27 +05:30
All open source (OSS) analyzers have been moved to the GitLab Free tier as of GitLab 13.3.
2020-07-28 23:09:34 +05:30
#### Summary of features per tier
Different features are available in different [GitLab tiers ](https://about.gitlab.com/pricing/ ),
as shown in the following table:
2021-06-08 01:23:25 +05:30
| Capability | In Free | In Ultimate |
|:---------------------------------------------------------------------------------------|:--------------------|:-------------------|
| [Configure SAST Scanners ](#configuration ) | ** {check-circle}** | ** {check-circle}** |
| [Customize SAST Settings ](#customizing-the-sast-settings ) | ** {check-circle}** | ** {check-circle}** |
| View [JSON Report ](#reports-json-format ) | ** {check-circle}** | ** {check-circle}** |
| Presentation of JSON Report in Merge Request | ** {dotted-circle}** | ** {check-circle}** |
| [Address vulnerabilities ](../../application_security/vulnerabilities/index.md ) | ** {dotted-circle}** | ** {check-circle}** |
| [Access to Security Dashboard ](../../application_security/security_dashboard/index.md ) | ** {dotted-circle}** | ** {check-circle}** |
| [Configure SAST in the UI ](#configure-sast-in-the-ui ) | ** {dotted-circle}** | ** {check-circle}** |
| [Customize SAST Rulesets ](#customize-rulesets ) | ** {dotted-circle}** | ** {check-circle}** |
2021-10-27 15:23:28 +05:30
| [False Positive Detection ](#false-positive-detection ) | ** {dotted-circle}** | ** {check-circle}** |
2020-07-28 23:09:34 +05:30
2020-04-22 19:07:51 +05:30
## Contribute your scanner
The [Security Scanner Integration ](../../../development/integrations/secure.md ) documentation explains how to integrate other security scanners into GitLab.
2019-09-30 21:07:59 +05:30
## Configuration
2019-07-31 22:56:46 +05:30
2020-10-24 23:57:45 +05:30
To configure SAST for a project you can:
2021-04-17 20:07:23 +05:30
- Use [Auto SAST ](../../../topics/autodevops/stages.md#auto-sast ), provided by
2020-10-24 23:57:45 +05:30
[Auto DevOps ](../../../topics/autodevops/index.md ).
- [Configure SAST manually ](#configure-sast-manually ).
- [Configure SAST using the UI ](#configure-sast-in-the-ui ) (introduced in GitLab 13.3).
### Configure SAST manually
2020-04-22 19:07:51 +05:30
2021-09-30 23:02:18 +05:30
For GitLab 11.9 and later, to enable SAST you must [include ](../../../ci/yaml/index.md#includetemplate )
2021-09-04 01:27:46 +05:30
the [`SAST.gitlab-ci.yml` template ](https://gitlab.com/gitlab-org/gitlab/-/blob/master/lib/gitlab/ci/templates/Security/SAST.gitlab-ci.yml )
2020-05-24 23:13:21 +05:30
provided as a part of your GitLab installation. For GitLab versions earlier than 11.9, you
2020-04-22 19:07:51 +05:30
can copy and use the job as defined that template.
2019-07-31 22:56:46 +05:30
2019-09-30 21:07:59 +05:30
Add the following to your `.gitlab-ci.yml` file:
2019-07-31 22:56:46 +05:30
```yaml
include:
2020-11-24 15:15:51 +05:30
- template: Security/SAST.gitlab-ci.yml
2019-07-31 22:56:46 +05:30
```
2020-10-24 23:57:45 +05:30
The included template creates SAST jobs in your CI/CD pipeline and scans
2019-07-31 22:56:46 +05:30
your project's source code for possible vulnerabilities.
2020-10-24 23:57:45 +05:30
The results are saved as a
2021-09-30 23:02:18 +05:30
[SAST report artifact ](../../../ci/yaml/index.md#artifactsreportssast )
2019-07-31 22:56:46 +05:30
that you can later download and analyze. Due to implementation limitations, we
2020-05-24 23:13:21 +05:30
always take the latest SAST artifact available.
2019-07-31 22:56:46 +05:30
2021-11-18 22:05:49 +05:30
### Configure SAST in the UI
You can enable and configure SAST in the UI, either with default settings, or with customizations.
Use the method that best meets your needs.
- [Configure SAST in the UI with default settings ](#configure-sast-in-the-ui-with-default-settings )
- [Configure SAST in the UI with customizations ](#configure-sast-in-the-ui-with-customizations )
2021-12-11 22:18:48 +05:30
### Configure SAST in the UI with default settings
2021-11-18 22:05:49 +05:30
> [Introduced](https://about.gitlab.com/releases/2021/02/22/gitlab-13-9-released/#security-configuration-page-for-all-users) in GitLab 13.9
To enable and configure SAST with default settings:
1. On the top bar, select **Menu > Projects** and find your project.
1. On the left sidebar, select **Security & Compliance** > **Configuration** .
1. In the SAST section, select `Enable via MR` .
1. Review the draft MR that enables SAST with the default recommended settings in the
`.gitlab-ci.yml` file.
1. Merge the MR to enable SAST. You should see SAST jobs run in that MR's pipeline.
NOTE:
The configuration tool works best with no existing `.gitlab-ci.yml` file, or with a minimal
configuration file. If you have a complex GitLab configuration file it may not be parsed
successfully, and an error may occur.
### Configure SAST in the UI with customizations **(ULTIMATE)**
2020-10-24 23:57:45 +05:30
2021-12-11 22:18:48 +05:30
> - [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/3659) in GitLab 13.3.
> - [Improved](https://gitlab.com/gitlab-org/gitlab/-/issues/232862) in GitLab 13.4.
> - [Improved](https://gitlab.com/groups/gitlab-org/-/epics/3635) in GitLab 13.5.
2020-10-24 23:57:45 +05:30
2021-11-18 22:05:49 +05:30
To enable and configure SAST with customizations:
2020-10-24 23:57:45 +05:30
2021-11-18 22:05:49 +05:30
1. On the top bar, select **Menu > Projects** and find your project.
1. On the left sidebar, select **Security & Compliance > Configuration** .
1. If the project does not have a `.gitlab-ci.yml` file, select **Enable** in the Static Application
Security Testing (SAST) row, otherwise select **Configure** .
2021-01-03 14:25:43 +05:30
1. Enter the custom SAST values.
2020-11-24 15:15:51 +05:30
2021-11-18 22:05:49 +05:30
Custom values are stored in the `.gitlab-ci.yml` file. For CI/CD variables not in the SAST
Configuration page, their values are left unchanged. Default values are inherited from the GitLab
SAST template.
2021-03-11 19:13:27 +05:30
2021-11-18 22:05:49 +05:30
1. Optionally, expand the **SAST analyzers** section, select individual
[SAST analyzers ](analyzers.md ) and enter custom analyzer values.
1. Select **Create Merge Request** .
2020-10-24 23:57:45 +05:30
1. Review and merge the merge request.
2021-11-18 22:05:49 +05:30
NOTE:
The configuration tool works best with no existing `.gitlab-ci.yml` file, or with a minimal
configuration file. If you have a complex GitLab configuration file it may not be parsed
successfully, and an error may occur.
2019-09-30 21:07:59 +05:30
### Customizing the SAST settings
2019-07-31 22:56:46 +05:30
2021-09-04 01:27:46 +05:30
The SAST settings can be changed through [CI/CD variables ](#available-cicd-variables )
2019-12-21 20:55:43 +05:30
by using the
2021-09-30 23:02:18 +05:30
[`variables` ](../../../ci/yaml/index.md#variables ) parameter in `.gitlab-ci.yml` .
2019-07-31 22:56:46 +05:30
In the following example, we include the SAST template and at the same time we
set the `SAST_GOSEC_LEVEL` variable to `2` :
```yaml
include:
2021-01-03 14:25:43 +05:30
- template: Security/SAST.gitlab-ci.yml
2019-07-31 22:56:46 +05:30
variables:
SAST_GOSEC_LEVEL: 2
```
2021-09-30 23:02:18 +05:30
Because the template is [evaluated before ](../../../ci/yaml/index.md#include )
2020-05-24 23:13:21 +05:30
the pipeline configuration, the last mention of the variable takes precedence.
2019-07-31 22:56:46 +05:30
2020-05-24 23:13:21 +05:30
### Overriding SAST jobs
2019-12-21 20:55:43 +05:30
2021-02-22 17:27:13 +05:30
WARNING:
2021-09-30 23:02:18 +05:30
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-22 19:07:51 +05:30
2020-05-24 23:13:21 +05:30
To override a job definition, (for example, change properties like `variables` or `dependencies` ),
declare a job with the same name as the SAST job to override. Place this new job after the template
inclusion and specify any additional keys under it. For example, this enables `FAIL_NEVER` for the
`spotbugs` analyzer:
2019-12-21 20:55:43 +05:30
```yaml
include:
2021-01-03 14:25:43 +05:30
- template: Security/SAST.gitlab-ci.yml
2019-12-21 20:55:43 +05:30
2020-05-24 23:13:21 +05:30
spotbugs-sast:
2019-12-21 20:55:43 +05:30
variables:
2020-05-24 23:13:21 +05:30
FAIL_NEVER: 1
2019-12-21 20:55:43 +05:30
```
2021-09-04 01:27:46 +05:30
#### Pinning to minor image version
While our templates use `MAJOR` version pinning to always ensure the latest analyzer
versions are pulled, there are certain cases where it can be beneficial to pin
an analyzer to a specific release. To do so, override the `SAST_ANALYZER_IMAGE_TAG` CI/CD variable
in the job template directly.
2021-11-18 22:05:49 +05:30
In the example below, we pin to a specific patch version of the `spotbugs` analyzer and minor version of the `semgrep` analyzer:
2021-09-04 01:27:46 +05:30
```yaml
include:
- template: Security/SAST.gitlab-ci.yml
2021-11-18 22:05:49 +05:30
semgrep-sast:
variables:
SAST_ANALYZER_IMAGE_TAG: "2.12"
2021-09-04 01:27:46 +05:30
spotbugs-sast:
variables:
SAST_ANALYZER_IMAGE_TAG: "2.28.1"
```
2021-01-29 00:20:46 +05:30
### Customize rulesets **(ULTIMATE)**
2021-01-03 14:25:43 +05:30
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/235382) in GitLab 13.5.
2021-01-29 00:20:46 +05:30
You can customize the default scanning rules provided by our SAST analyzers.
Ruleset customization supports two capabilities:
2021-06-08 01:23:25 +05:30
1. Disabling predefined rules (available for all analyzers).
1. Modifying the default behavior of a given analyzer (only available for `nodejs-scan` and `gosec` ).
2021-01-29 00:20:46 +05:30
These capabilities can be used simultaneously.
2021-01-03 14:25:43 +05:30
To customize the default scanning rules, create a file containing custom rules. These rules
2021-01-29 00:20:46 +05:30
are passed through to the analyzer's underlying scanner tools.
2021-01-03 14:25:43 +05:30
To create a custom ruleset:
1. Create a `.gitlab` directory at the root of your project, if one doesn't already exist.
1. Create a custom ruleset file named `sast-ruleset.toml` in the `.gitlab` directory.
1. In the `sast-ruleset.toml` file, do one of the following:
2021-03-11 19:13:27 +05:30
- Disable predefined rules belonging to SAST analyzers. In this example, the three disabled rules
belong to `eslint` and `sobelow` by matching the corresponding identifiers' `type` and `value` :
2021-01-29 00:20:46 +05:30
```toml
[eslint]
[[eslint.ruleset]]
disable = true
[eslint.ruleset.identifier]
type = "eslint_rule_id"
value = "security/detect-object-injection"
2021-03-11 19:13:27 +05:30
[[eslint.ruleset]]
disable = true
[eslint.ruleset.identifier]
type = "cwe"
value = "185"
2021-01-29 00:20:46 +05:30
[sobelow]
[[sobelow.ruleset]]
disable = true
[sobelow.ruleset.identifier]
type = "sobelow_rule_id"
value = "sql_injection"
```
2021-01-03 14:25:43 +05:30
- Define a custom analyzer configuration. In this example, customized rules are defined for the
`nodejs-scan` scanner:
```toml
[nodejs-scan]
description = 'custom ruleset for nodejs-scan'
[[nodejs-scan.passthrough]]
type = "raw"
value = '''
- nodejs-extensions:
- .js
template-extensions:
- .new
- .hbs
- ''
ignore-filenames:
- skip.js
ignore-paths:
- __MACOSX
- skip_dir
- node_modules
ignore-extensions:
- .hbs
ignore-rules:
- regex_injection_dos
- pug_jade_template
- express_xss
'''
```
- Provide the name of the file containing a custom analyzer configuration. In this example,
customized rules for the `gosec` scanner are contained in the file `gosec-config.json` :
```toml
[gosec]
description = 'custom ruleset for gosec'
[[gosec.passthrough]]
type = "file"
value = "gosec-config.json"
```
2021-10-27 15:23:28 +05:30
### False Positive Detection **(ULTIMATE)**
2021-12-11 22:18:48 +05:30
> Introduced in GitLab 14.2.
2021-10-27 15:23:28 +05:30
Vulnerabilities that have been detected and are false positives will be flagged as false positives in the security dashboard.
2021-03-11 19:13:27 +05:30
### Using CI/CD variables to pass credentials for private repositories
2019-12-26 22:10:19 +05:30
Some analyzers require downloading the project's dependencies in order to
perform the analysis. In turn, such dependencies may live in private Git
repositories and thus require credentials like username and password to download them.
Depending on the analyzer, such credentials can be provided to
2021-03-11 19:13:27 +05:30
it via [custom CI/CD variables ](#custom-cicd-variables ).
2019-12-26 22:10:19 +05:30
2021-03-11 19:13:27 +05:30
#### Using a CI/CD variable to pass username and password to a private Maven repository
2019-12-04 20:38:33 +05:30
2020-05-24 23:13:21 +05:30
If your private Maven repository requires login credentials,
2021-03-11 19:13:27 +05:30
you can use the `MAVEN_CLI_OPTS` CI/CD variable.
2019-12-04 20:38:33 +05:30
2021-03-11 19:13:27 +05:30
Read more on [how to use private Maven repositories ](../index.md#using-private-maven-repositories ).
2019-12-04 20:38:33 +05:30
2021-01-29 00:20:46 +05:30
### Enabling Kubesec analyzer
2020-01-01 13:55:28 +05:30
2021-12-11 22:18:48 +05:30
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/12752) in GitLab 12.6.
2020-01-01 13:55:28 +05:30
2020-05-24 23:13:21 +05:30
You need to set `SCAN_KUBERNETES_MANIFESTS` to `"true"` to enable the
Kubesec analyzer. In `.gitlab-ci.yml` , define:
2020-01-01 13:55:28 +05:30
```yaml
include:
2021-01-03 14:25:43 +05:30
- template: Security/SAST.gitlab-ci.yml
2020-01-01 13:55:28 +05:30
variables:
SCAN_KUBERNETES_MANIFESTS: "true"
```
2021-01-29 00:20:46 +05:30
### Pre-compilation
2020-03-13 15:44:24 +05:30
If your project requires custom build configurations, it can be preferable to avoid
compilation during your SAST execution and instead pass all job artifacts from an
2021-02-22 17:27:13 +05:30
earlier stage in the pipeline. This is the current strategy when requiring
2020-03-13 15:44:24 +05:30
a `before_script` execution to prepare your scan job.
To pass your project's dependencies as artifacts, the dependencies must be included
in the project's working directory and specified using the `artifacts:path` configuration.
2021-03-11 19:13:27 +05:30
If all dependencies are present, the `COMPILE=false` CI/CD variable can be provided to the
2021-02-22 17:27:13 +05:30
analyzer and compilation is skipped:
2020-03-13 15:44:24 +05:30
```yaml
stages:
2020-11-24 15:15:51 +05:30
- build
- test
2020-03-13 15:44:24 +05:30
include:
2021-01-03 14:25:43 +05:30
- template: Security/SAST.gitlab-ci.yml
2020-03-13 15:44:24 +05:30
build:
2021-04-17 20:07:23 +05:30
image: maven:3.6-jdk-8-slim
2020-03-13 15:44:24 +05:30
stage: build
script:
- mvn package -Dmaven.repo.local=./.m2/repository
artifacts:
paths:
- .m2/
- target/
spotbugs-sast:
dependencies:
- build
variables:
MAVEN_REPO_PATH: ./.m2/repository
2021-01-03 14:25:43 +05:30
COMPILE: "false"
2020-03-13 15:44:24 +05:30
artifacts:
reports:
sast: gl-sast-report.json
```
2021-01-03 14:25:43 +05:30
To allow the analyzer to recognize the compiled artifacts, you must explicitly specify the path to
the vendored directory. This configuration can vary per analyzer but in the case of Java above, you
can use `MAVEN_REPO_PATH` . See
[Analyzer settings ](#analyzer-settings ) for the complete list of available options.
2020-03-13 15:44:24 +05:30
2021-09-04 01:27:46 +05:30
### Available CI/CD variables
2019-10-12 21:52:04 +05:30
2021-03-11 19:13:27 +05:30
SAST can be [configured ](#customizing-the-sast-settings ) using CI/CD variables.
2019-10-12 21:52:04 +05:30
2020-10-24 23:57:45 +05:30
#### Logging level
2020-07-28 23:09:34 +05:30
2021-02-22 17:27:13 +05:30
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/10880) in GitLab 13.1.
To control the verbosity of logs, set the `SECURE_LOG_LEVEL` environment variable. Messages of this
logging level or higher are output.
2020-10-24 23:57:45 +05:30
From highest to lowest severity, the logging levels are:
2020-07-28 23:09:34 +05:30
- `fatal`
- `error`
- `warn`
2020-10-24 23:57:45 +05:30
- `info` (default)
2020-07-28 23:09:34 +05:30
- `debug`
2020-04-08 14:13:33 +05:30
#### Custom Certificate Authority
To trust a custom Certificate Authority, set the `ADDITIONAL_CA_CERT_BUNDLE` variable to the bundle
2021-03-11 19:13:27 +05:30
of CA certs that you want to trust in the SAST environment. 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:
```yaml
variables:
ADDITIONAL_CA_CERT_BUNDLE: |
-----BEGIN CERTIFICATE-----
MIIGqTCCBJGgAwIBAgIQI7AVxxVwg2kch4d56XNdDjANBgkqhkiG9w0BAQsFADCB
...
jWgmPqF3vUbZE0EyScetPJquRFRKIesyJuBFMAs=
-----END CERTIFICATE-----
```
2021-09-30 23:02:18 +05:30
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.
2020-04-08 14:13:33 +05:30
2019-10-12 21:52:04 +05:30
#### Docker images
2021-03-11 19:13:27 +05:30
The following are Docker image-related CI/CD variables.
2019-10-12 21:52:04 +05:30
2021-03-11 19:13:27 +05:30
| CI/CD variable | Description |
2020-10-24 23:57:45 +05:30
|---------------------------|---------------------------------------------------------------------------------------------------------------------------------------|
| `SECURE_ANALYZERS_PREFIX` | Override the name of the Docker registry providing the default images (proxy). Read more about [customizing analyzers ](analyzers.md ). |
2021-03-08 18:12:59 +05:30
| `SAST_EXCLUDED_ANALYZERS` | Names of default images that should never run. Read more about [customizing analyzers ](analyzers.md ). |
2021-09-04 01:27:46 +05:30
| `SAST_ANALYZER_IMAGE_TAG` | Override the default version of analyzer image. Read more about [pinning the analyzer image version ](#pinning-to-minor-image-version ). |
2019-10-12 21:52:04 +05:30
2019-12-21 20:55:43 +05:30
#### Vulnerability filters
2019-10-12 21:52:04 +05:30
Some analyzers make it possible to filter out vulnerabilities under a given threshold.
2021-03-11 19:13:27 +05:30
| CI/CD variable | Default value | Description |
|------------------------------|--------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
2021-06-08 01:23:25 +05:30
| `SAST_EXCLUDED_PATHS` | `spec, test, tests, tmp` | Exclude vulnerabilities from output based on the paths. This is a comma-separated list of patterns. Patterns can be globs, or file or folder paths (for example, `doc,spec` ). Parent directories also match patterns. You might need to exclude temporary directories used by your build tool as these can generate false positives. To exclude paths, copy and paste the default excluded paths, then **add** your own paths to be excluded. If you don't specify the default excluded paths, you will override the defaults and _only_ paths you specify will be excluded from the SAST scans. |
2021-03-11 19:13:27 +05:30
| `SEARCH_MAX_DEPTH` | 4 | SAST searches the repository to detect the programming languages used, and selects the matching analyzers. Set the value of `SEARCH_MAX_DEPTH` to specify how many directory levels the search phase should span. After the analyzers have been selected, the _entire_ repository is analyzed. |
| `SAST_BANDIT_EXCLUDED_PATHS` | | Comma-separated list of paths to exclude from scan. Uses Python's [`fnmatch` syntax ](https://docs.python.org/2/library/fnmatch.html ); For example: `'*/tests/*, */venv/*'` |
| `SAST_BRAKEMAN_LEVEL` | 1 | Ignore Brakeman vulnerabilities under given confidence level. Integer, 1=Low 3=High. |
| `SAST_FLAWFINDER_LEVEL` | 1 | Ignore Flawfinder vulnerabilities under given risk level. Integer, 0=No risk, 5=High risk. |
| `SAST_GOSEC_LEVEL` | 0 | Ignore Gosec vulnerabilities under given confidence level. Integer, 0=Undefined, 1=Low, 2=Medium, 3=High. |
2019-12-26 22:10:19 +05:30
2019-12-21 20:55:43 +05:30
#### Analyzer settings
2019-10-12 21:52:04 +05:30
2021-03-11 19:13:27 +05:30
Some analyzers can be customized with CI/CD variables.
| CI/CD variable | Analyzer | Description |
|-----------------------------|------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `SCAN_KUBERNETES_MANIFESTS` | Kubesec | Set to `"true"` to scan Kubernetes manifests. |
| `KUBESEC_HELM_CHARTS_PATH` | Kubesec | Optional path to Helm charts that `helm` uses to generate a Kubernetes manifest that `kubesec` scans. If dependencies are defined, `helm dependency build` should be ran in a `before_script` to fetch the necessary dependencies. |
| `KUBESEC_HELM_OPTIONS` | Kubesec | Additional arguments for the `helm` executable. |
2021-09-30 23:02:18 +05:30
| `COMPILE` | Gosec, SpotBugs | Set to `false` to disable project compilation and dependency fetching. [Introduced for `SpotBugs` ](https://gitlab.com/gitlab-org/gitlab/-/issues/195252 ) analyzer in GitLab 13.1 and [`Gosec` ](https://gitlab.com/gitlab-org/gitlab/-/issues/330678 ) analyzer in GitLab 14.0. |
2021-03-11 19:13:27 +05:30
| `ANT_HOME` | SpotBugs | The `ANT_HOME` variable. |
| `ANT_PATH` | SpotBugs | Path to the `ant` executable. |
| `GRADLE_PATH` | SpotBugs | Path to the `gradle` executable. |
| `JAVA_OPTS` | SpotBugs | Additional arguments for the `java` executable. |
| `JAVA_PATH` | SpotBugs | Path to the `java` executable. |
| `SAST_JAVA_VERSION` | SpotBugs | Which Java version to use. Supported versions are `8` and `11` . Defaults to `8` . |
| `MAVEN_CLI_OPTS` | SpotBugs | Additional arguments for the `mvn` or `mvnw` executable. |
| `MAVEN_PATH` | SpotBugs | Path to the `mvn` executable. |
| `MAVEN_REPO_PATH` | SpotBugs | Path to the Maven local repository (shortcut for the `maven.repo.local` property). |
| `SBT_PATH` | SpotBugs | Path to the `sbt` executable. |
| `FAIL_NEVER` | SpotBugs | Set to `1` to ignore compilation failure. |
2021-09-04 01:27:46 +05:30
| `SAST_GOSEC_CONFIG` | Gosec | ** {warning}** ** [Removed ](https://gitlab.com/gitlab-org/gitlab/-/issues/328301 )** in GitLab 14.0 - use custom rulesets instead. Path to configuration for Gosec (optional). |
2021-09-30 23:02:18 +05:30
| `PHPCS_SECURITY_AUDIT_PHP_EXTENSIONS` | phpcs-security-audit | Comma separated list of additional PHP Extensions. |
| `SAST_DISABLE_BABEL` | NodeJsScan | ** {warning}** ** [Removed ](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/64025 )** in GitLab 13.5 |
2021-09-04 01:27:46 +05:30
| `SAST_SEMGREP_METRICS` | Semgrep | Set to `"false"` to disable sending anonymized scan metrics to [r2c ](https://r2c.dev/ ). Default: `true` . [Introduced ](https://gitlab.com/gitlab-org/gitlab/-/issues/330565 ) in GitLab 14.0. |
2021-03-11 19:13:27 +05:30
#### Custom CI/CD variables
2019-12-26 22:10:19 +05:30
2021-12-11 22:18:48 +05:30
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/18193) in GitLab 12.5.
2019-12-26 22:10:19 +05:30
2021-03-11 19:13:27 +05:30
In addition to the aforementioned SAST configuration CI/CD variables,
2021-09-30 23:02:18 +05:30
all [custom variables ](../../../ci/variables/index.md#custom-cicd-variables ) are propagated
2019-12-26 22:10:19 +05:30
to the underlying SAST analyzer images if
[the SAST vendored template ](#configuration ) is used.
2021-11-18 22:05:49 +05:30
NOTE:
In [GitLab 13.3 and earlier ](https://gitlab.com/gitlab-org/gitlab/-/issues/220540 ),
variables whose names started with the following prefixes are **not** propagated to either the
analyzer containers or SAST Docker container: `DOCKER_` , `CI` , `GITLAB_` , `FF_` , `HOME` , `PWD` ,
`OLDPWD` , `PATH` , `SHLVL` , `HOSTNAME` .
2019-12-26 22:10:19 +05:30
2021-01-03 14:25:43 +05:30
### Experimental features
2021-02-22 17:27:13 +05:30
You can receive early access to experimental features. Experimental features might be added,
removed, or promoted to regular features at any time.
Experimental features available are:
- Enable scanning of iOS and Android apps using the [MobSF analyzer ](https://gitlab.com/gitlab-org/security-products/analyzers/mobsf/ ).
2021-01-03 14:25:43 +05:30
2021-02-22 17:27:13 +05:30
#### Enable experimental features
2021-01-03 14:25:43 +05:30
To enable experimental features, add the following to your `.gitlab-ci.yml` file:
```yaml
include:
- template: Security/SAST.gitlab-ci.yml
variables:
SAST_EXPERIMENTAL_FEATURES: "true"
```
2019-09-04 21:01:54 +05:30
## Reports JSON format
2020-06-23 00:09:42 +05:30
The SAST tool emits a JSON report file. For more information, see the
[schema for this report ](https://gitlab.com/gitlab-org/security-products/security-report-schemas/-/blob/master/dist/sast-report-format.json ).
2019-09-04 21:01:54 +05:30
2021-01-03 14:25:43 +05:30
The JSON report file can be downloaded from the CI pipelines page, or the
2021-09-30 23:02:18 +05:30
pipelines tab on merge requests by [setting `artifacts: paths` ](../../../ci/yaml/index.md#artifactspaths ) to `gl-sast-report.json` . For more information see [Downloading artifacts ](../../../ci/pipelines/job_artifacts.md ).
2020-10-24 23:57:45 +05:30
2020-06-23 00:09:42 +05:30
Here's an example SAST report:
2019-09-04 21:01:54 +05:30
```json-doc
{
"version": "2.0",
"vulnerabilities": [
{
2020-04-22 19:07:51 +05:30
"id": "9e96e0ab-23da-4d7d-a09e-0acbaa5e83ca",
2019-09-04 21:01:54 +05:30
"category": "sast",
"name": "Predictable pseudorandom number generator",
"message": "Predictable pseudorandom number generator",
"description": "The use of java.util.Random is predictable",
"severity": "Medium",
"confidence": "Medium",
"scanner": {
"id": "find_sec_bugs",
"name": "Find Security Bugs"
},
"location": {
"file": "groovy/src/main/groovy/com/gitlab/security_products/tests/App.groovy",
"start_line": 47,
"end_line": 47,
"class": "com.gitlab.security_products.tests.App",
"method": "generateSecretToken2",
"dependency": {
"package": {}
}
},
"identifiers": [
{
"type": "find_sec_bugs_type",
"name": "Find Security Bugs-PREDICTABLE_RANDOM",
"value": "PREDICTABLE_RANDOM",
"url": "https://find-sec-bugs.github.io/bugs.htm#PREDICTABLE_RANDOM"
},
{
"type": "cwe",
"name": "CWE-330",
"value": "330",
"url": "https://cwe.mitre.org/data/definitions/330.html"
}
]
2019-09-30 21:07:59 +05:30
},
2019-09-04 21:01:54 +05:30
{
2020-04-22 19:07:51 +05:30
"id": "e6dbf91f-4c07-46f7-a365-0169489c27d1",
2019-09-04 21:01:54 +05:30
"category": "sast",
"message": "Probable insecure usage of temp file/directory.",
"severity": "Medium",
"confidence": "Medium",
"scanner": {
"id": "bandit",
"name": "Bandit"
},
"location": {
"file": "python/hardcoded/hardcoded-tmp.py",
"start_line": 10,
"end_line": 10,
"dependency": {
"package": {}
}
},
"identifiers": [
{
"type": "bandit_test_id",
"name": "Bandit Test ID B108",
"value": "B108",
"url": "https://docs.openstack.org/bandit/latest/plugins/b108_hardcoded_tmp_directory.html"
}
]
2019-09-30 21:07:59 +05:30
},
2019-09-04 21:01:54 +05:30
],
"remediations": []
}
```
2020-04-22 19:07:51 +05:30
## Running SAST in an offline environment
2020-04-08 14:13:33 +05:30
For self-managed GitLab instances in an environment with limited, restricted, or intermittent access
2020-04-22 19:07:51 +05:30
to external resources through the internet, some adjustments are required for the SAST job to
2020-05-24 23:13:21 +05:30
run successfully. For more information, see [Offline environments ](../offline_deployments/index.md ).
2020-04-08 14:13:33 +05:30
### Requirements for offline SAST
To use SAST in an offline environment, you need:
2020-11-24 15:15:51 +05:30
- GitLab Runner with the [`docker` or `kubernetes` executor ](#requirements ).
2020-10-24 23:57:45 +05:30
- A Docker Container Registry with locally available copies of SAST [analyzer ](https://gitlab.com/gitlab-org/security-products/analyzers ) images.
- Configure certificate checking of packages (optional).
2020-04-08 14:13:33 +05:30
GitLab Runner has a [default `pull policy` of `always` ](https://docs.gitlab.com/runner/executors/docker.html#using-the-always-pull-policy ),
2020-11-24 15:15:51 +05:30
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-04-22 19:07:51 +05:30
in an offline environment if you prefer using only locally available Docker images. However, we
2020-05-24 23:13:21 +05:30
recommend keeping the pull policy setting to `always` if not in an offline environment, as this
enables the use of updated scanners in your CI/CD pipelines.
2020-04-08 14:13:33 +05:30
### Make GitLab SAST analyzer images available inside your Docker registry
For SAST with all [supported languages and frameworks ](#supported-languages-and-frameworks ),
2020-05-24 23:13:21 +05:30
import the following default SAST analyzer images from `registry.gitlab.com` into your
[local Docker container registry ](../../packages/container_registry/index.md ):
2020-04-08 14:13:33 +05:30
2020-04-22 19:07:51 +05:30
```plaintext
2021-11-11 11:23:49 +05:30
registry.gitlab.com/security-products/sast/bandit:2
registry.gitlab.com/security-products/sast/brakeman:2
registry.gitlab.com/security-products/sast/eslint:2
registry.gitlab.com/security-products/sast/flawfinder:2
registry.gitlab.com/security-products/sast/gosec:3
registry.gitlab.com/security-products/sast/kubesec:2
registry.gitlab.com/security-products/sast/nodejs-scan:2
registry.gitlab.com/security-products/sast/phpcs-security-audit:2
registry.gitlab.com/security-products/sast/pmd-apex:2
registry.gitlab.com/security-products/sast/security-code-scan:2
registry.gitlab.com/security-products/sast/semgrep:2
registry.gitlab.com/security-products/sast/sobelow:2
registry.gitlab.com/security-products/sast/spotbugs:2
2020-04-08 14:13:33 +05:30
```
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
2021-06-08 01:23:25 +05:30
process by which external resources can be imported or temporarily accessed. 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-08 14:13:33 +05:30
For details on saving and transporting Docker images as a file, see Docker's documentation on
[`docker save` ](https://docs.docker.com/engine/reference/commandline/save/ ), [`docker load` ](https://docs.docker.com/engine/reference/commandline/load/ ),
[`docker export` ](https://docs.docker.com/engine/reference/commandline/export/ ), and [`docker import` ](https://docs.docker.com/engine/reference/commandline/import/ ).
2021-01-03 14:25:43 +05:30
#### If support for Custom Certificate Authorities are needed
Support for custom certificate authorities was introduced in the following versions.
2021-03-11 19:13:27 +05:30
| Analyzer | Version |
| -------- | ------- |
| `bandit` | [v2.3.0 ](https://gitlab.com/gitlab-org/security-products/analyzers/bandit/-/releases/v2.3.0 ) |
| `brakeman` | [v2.1.0 ](https://gitlab.com/gitlab-org/security-products/analyzers/brakeman/-/releases/v2.1.0 ) |
| `eslint` | [v2.9.2 ](https://gitlab.com/gitlab-org/security-products/analyzers/eslint/-/releases/v2.9.2 ) |
| `flawfinder` | [v2.3.0 ](https://gitlab.com/gitlab-org/security-products/analyzers/flawfinder/-/releases/v2.3.0 ) |
| `gosec` | [v2.5.0 ](https://gitlab.com/gitlab-org/security-products/analyzers/gosec/-/releases/v2.5.0 ) |
| `kubesec` | [v2.1.0 ](https://gitlab.com/gitlab-org/security-products/analyzers/kubesec/-/releases/v2.1.0 ) |
| `nodejs-scan` | [v2.9.5 ](https://gitlab.com/gitlab-org/security-products/analyzers/nodejs-scan/-/releases/v2.9.5 ) |
2021-01-03 14:25:43 +05:30
| `phpcs-security-audit` | [v2.8.2 ](https://gitlab.com/gitlab-org/security-products/analyzers/phpcs-security-audit/-/releases/v2.8.2 ) |
2021-03-11 19:13:27 +05:30
| `pmd-apex` | [v2.1.0 ](https://gitlab.com/gitlab-org/security-products/analyzers/pmd-apex/-/releases/v2.1.0 ) |
| `security-code-scan` | [v2.7.3 ](https://gitlab.com/gitlab-org/security-products/analyzers/security-code-scan/-/releases/v2.7.3 ) |
2021-06-08 01:23:25 +05:30
| `semgrep` | [v0.0.1 ](https://gitlab.com/gitlab-org/security-products/analyzers/semgrep/-/releases/v0.0.1 ) |
2021-03-11 19:13:27 +05:30
| `sobelow` | [v2.2.0 ](https://gitlab.com/gitlab-org/security-products/analyzers/sobelow/-/releases/v2.2.0 ) |
| `spotbugs` | [v2.7.1 ](https://gitlab.com/gitlab-org/security-products/analyzers/spotbugs/-/releases/v2.7.1 ) |
2021-01-03 14:25:43 +05:30
2021-03-11 19:13:27 +05:30
### Set SAST CI/CD variables to use local SAST analyzers
2020-04-08 14:13:33 +05:30
2020-05-24 23:13:21 +05:30
Add the following configuration to your `.gitlab-ci.yml` file. You must replace
2020-07-28 23:09:34 +05:30
`SECURE_ANALYZERS_PREFIX` to refer to your local Docker container registry:
2020-04-08 14:13:33 +05:30
2020-11-24 15:15:51 +05:30
```yaml
2020-04-08 14:13:33 +05:30
include:
2021-01-03 14:25:43 +05:30
- template: Security/SAST.gitlab-ci.yml
2020-04-08 14:13:33 +05:30
variables:
2020-05-24 23:13:21 +05:30
SECURE_ANALYZERS_PREFIX: "localhost:5000/analyzers"
2020-11-24 15:15:51 +05:30
```
2020-04-08 14:13:33 +05:30
The SAST job should now use local copies of the SAST analyzers to scan your code and generate
security reports without requiring internet access.
2020-10-24 23:57:45 +05:30
### Configure certificate checking of packages
If a SAST job invokes a package manager, you must configure its certificate verification. In an
2021-01-29 00:20:46 +05:30
offline environment, certificate verification with an external source is not possible. Either use a
2020-10-24 23:57:45 +05:30
self-signed certificate or disable certificate verification. Refer to the package manager's
documentation for instructions.
2021-04-29 21:17:54 +05:30
## Running SAST in SELinux
2021-06-08 01:23:25 +05:30
By default SAST analyzers are supported in GitLab instances hosted on SELinux. Adding a `before_script` in an [overridden SAST job ](#overriding-sast-jobs ) may not work as runners hosted on SELinux have restricted permissions.
2021-04-29 21:17:54 +05:30
2019-12-04 20:38:33 +05:30
## Troubleshooting
2019-10-12 21:52:04 +05:30
2021-04-29 21:17:54 +05:30
### SAST debug logging
Increase the [Secure scanner log verbosity ](#logging-level ) to `debug` in a global CI variable to help troubleshoot SAST jobs.
```yaml
variables:
SECURE_LOG_LEVEL: "debug"
```
2020-06-23 00:09:42 +05:30
### `Error response from daemon: error processing tar file: docker-tar: relocation error`
2019-10-12 21:52:04 +05:30
2020-05-24 23:13:21 +05:30
This error occurs when the Docker version that runs the SAST job is `19.03.0` .
Consider updating to Docker `19.03.1` or greater. Older versions are not
2019-12-04 20:38:33 +05:30
affected. Read more in
2020-06-23 00:09:42 +05:30
[this issue ](https://gitlab.com/gitlab-org/gitlab/-/issues/13830#note_211354992 "Current SAST container fails" ).
2021-01-03 14:25:43 +05:30
### Getting warning message `gl-sast-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 ).
2021-03-11 19:13:27 +05:30
### Error: `sast 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-01-03 14:25:43 +05:30
### Limitation when using rules:exists
The [SAST CI template ](https://gitlab.com/gitlab-org/gitlab/-/blob/master/lib/gitlab/ci/templates/Security/SAST.gitlab-ci.yml )
uses the `rules:exists` parameter. For performance reasons, a maximum number of matches are made
against the given glob pattern. If the number of matches exceeds the maximum, the `rules:exists`
parameter returns `true` . Depending on the number of files in your repository, a SAST job might be
triggered even if the scanner doesn't support your project. For more details about this issue, see
2021-09-30 23:02:18 +05:30
the [`rules:exists` documentation ](../../../ci/yaml/index.md#rulesexists ).
2021-03-08 18:12:59 +05:30
### SpotBugs UTF-8 unmappable character errors
These errors occur when UTF-8 encoding isn't enabled on a SpotBugs build and there are UTF-8
characters in the source code. To fix this error, enable UTF-8 for your project's build tool.
For Gradle builds, add the following to your `build.gradle` file:
```gradle
compileJava.options.encoding = 'UTF-8'
tasks.withType(JavaCompile) {
options.encoding = 'UTF-8'
}
```
For Maven builds, add the following to your `pom.xml` file:
```xml
< properties >
< project.build.sourceEncoding > UTF-8< / project.build.sourceEncoding >
< / properties >
```
2021-03-11 19:13:27 +05:30
### Flawfinder encoding error
2021-09-30 23:02:18 +05:30
This occurs when Flawfinder encounters an invalid UTF-8 character. To fix this, convert all source code in your project to UTF-8 character encoding. This can be done with [`cvt2utf` ](https://github.com/x1angli/cvt2utf ) or [`iconv` ](https://www.gnu.org/software/libiconv/documentation/libiconv-1.13/iconv.1.html ) either over the entire project or per job using the [`before_script` ](../../../ci/yaml/index.md#before_script ) feature.
2021-09-04 01:27:46 +05:30
### Semgrep slowness, unexpected results, or other errors
If Semgrep is slow, reports too many false positives or false negatives, crashes, fails, or is otherwise broken, see the Semgrep docs for [troubleshooting GitLab SAST ](https://semgrep.dev/docs/troubleshooting/gitlab-sast/ ).
2021-11-18 22:05:49 +05:30
### SAST 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.
Several workarounds are available. From GitLab version 13.0 and later, you must not use
Docker-in-Docker.
#### Workaround 1: Pin analyzer versions (GitLab 12.1 and earlier)
Set the following variables for the SAST job. This pins the analyzer versions to the last known
working version, allowing SAST with Docker-in-Docker to complete as it did previously:
```yaml
sast:
variables:
SAST_DEFAULT_ANALYZERS: ""
SAST_ANALYZER_IMAGES: "registry.gitlab.com/gitlab-org/security-products/analyzers/bandit:2.9.6, registry.gitlab.com/gitlab-org/security-products/analyzers/brakeman:2.11.0, registry.gitlab.com/gitlab-org/security-products/analyzers/eslint:2.10.0, registry.gitlab.com/gitlab-org/security-products/analyzers/flawfinder:2.11.1, registry.gitlab.com/gitlab-org/security-products/analyzers/gosec:2.14.0, registry.gitlab.com/gitlab-org/security-products/analyzers/nodejs-scan:2.11.0, registry.gitlab.com/gitlab-org/security-products/analyzers/phpcs-security-audit:2.9.1, registry.gitlab.com/gitlab-org/security-products/analyzers/pmd-apex:2.9.0, registry.gitlab.com/gitlab-org/security-products/analyzers/secrets:3.12.0, registry.gitlab.com/gitlab-org/security-products/analyzers/security-code-scan:2.13.0, registry.gitlab.com/gitlab-org/security-products/analyzers/sobelow:2.8.0, registry.gitlab.com/gitlab-org/security-products/analyzers/spotbugs:2.13.6, registry.gitlab.com/gitlab-org/security-products/analyzers/tslint:2.4.0"
```
Remove any analyzers you don't need from the `SAST_ANALYZER_IMAGES` list. Keep
`SAST_DEFAULT_ANALYZERS` set to an empty string `""` .
#### Workaround 2: Disable Docker-in-Docker for SAST and Dependency Scanning (GitLab 12.3 and later)
Disable Docker-in-Docker for SAST. Individual `<analyzer-name>-sast` jobs are created for each
analyzer that runs in your CI/CD pipeline.
```yaml
include:
- template: SAST.gitlab-ci.yml
variables:
SAST_DISABLE_DIND: "true"
```
#### Workaround 3: Upgrade to GitLab 13.x and use the defaults
From GitLab 13.0, SAST defaults to not using Docker-in-Docker. In GitLab 13.4 and later, SAST using
Docker-in-Docker is [no longer supported ](https://gitlab.com/gitlab-org/gitlab/-/issues/220540 ).
If you have this problem on GitLab 13.x and later, you have customized your SAST job to
use Docker-in-Docker. To resolve this, comment out any customizations you've made to
your SAST CI job definition and [follow the documentation ](index.md#configuration )
to reconfigure, using the new and improved job definition default values.
```yaml
include:
- template: Security/SAST.gitlab-ci.yml
```
