mirror of
https://gitlab.com/components/sast.git
synced 2025-06-30 07:28:29 +02:00
52 lines
2.5 KiB
Markdown
52 lines
2.5 KiB
Markdown
# SAST (Static Application Security Testing)
|
|
|
|
Read more about this feature here: https://docs.gitlab.com/ee/user/application_security/sast/
|
|
|
|
Configure SAST with CI/CD variables (https://docs.gitlab.com/ee/ci/variables/index.html).
|
|
List of available variables: https://docs.gitlab.com/ee/user/application_security/sast/index.html#available-cicd-variables
|
|
|
|
## Usage
|
|
|
|
You should add this component to an existing `.gitlab-ci.yml` file by using the `include:`
|
|
keyword.
|
|
|
|
```yaml
|
|
include:
|
|
- component: gitlab.com/components/sast/sast@<VERSION>
|
|
```
|
|
|
|
where `<VERSION>` is the latest released tag or `main`.
|
|
|
|
If you are converting the configuration to use components and want to leverage the existing variable `$SAST_DISABLED` you could conditionally include the component using the variable:
|
|
|
|
```yaml
|
|
include:
|
|
- component: gitlab.com/components/sast/sast@main
|
|
rules:
|
|
- if: $SAST_DISABLED == "true" || $SAST_DISABLED == "1"
|
|
when: never
|
|
- when: always
|
|
```
|
|
|
|
Otherwise all SAST jobs will always run when applicable.
|
|
|
|
This assumes `SAST_DISABLED` variable is already defined in `.gitlab-ci.yml` with either `'true'` or `'1'` as the value.
|
|
|
|
### Inputs
|
|
|
|
| Input | Default value | Description |
|
|
| ----- | ------------- | ----------- |
|
|
| `stage` | `test` | The stage where you want the job to be added |
|
|
| `image_prefix` | `$CI_TEMPLATE_REGISTRY_HOST/security-products` | Define where all Docker image are pulled from |
|
|
| `image_tag` | `4` | Tag of the Docker image to use |
|
|
| `image_suffix` | `""` | Suffix added to image. If set to `-fips`, [`FIPS-enabled` images](https://docs.gitlab.com/ee/user/application_security/sast/#fips-enabled-images) are used for scan. Only used by `semgrep` analyzer |
|
|
| `excluded_analyzers` | `""` | Comma separated list of analyzers that should not run |
|
|
| `excluded_paths` | `"spec, test, tests, tmp"` | Comma separated list of paths to exclude |
|
|
| `search_max_depth` | `4` | Defines how many directory levels the search for programming languages should span |
|
|
| `run_kubesec_sast` | `"false"` | Set it to `"true"` to run `kubesec-sast` job |
|
|
| `run_advanced_sast` | `true` | Set it to `false` to disable [GitLab Advanced SAST](https://docs.gitlab.com/ee/user/application_security/sast/gitlab_advanced_sast.html) ]
|
|
| `include_experimental` | `"false"` | Set it to `"true"` to enable [experimental analyzers](https://docs.gitlab.com/ee/user/application_security/sast/#experimental-features) |
|
|
|
|
## Contribute
|
|
|
|
Please read about CI/CD components and best practices at: https://docs.gitlab.com/ee/ci/components
|