mirror of
https://gitlab.com/components/sast.git
synced 2025-07-01 07:48:28 +02:00
Compare commits
11 commits
773992a8d0
...
80aeead68f
Author | SHA1 | Date | |
---|---|---|---|
|
80aeead68f | ||
|
32b811c5ad | ||
|
04681f8725 | ||
|
5ee8b4583a | ||
|
5758da0696 | ||
|
7f7984b96d | ||
|
70e2583135 | ||
|
8c5526b0f4 | ||
|
4ea446f709 | ||
|
c6ea9d4f34 | ||
|
446d4146f5 |
2 changed files with 16 additions and 12 deletions
18
README.md
18
README.md
|
@ -1,5 +1,5 @@
|
||||||
|
|
||||||
This project provides componnets for the use of Static Application Security Testing as well as Infrastructure as Code testing.
|
This project provides components for the use of Static Application Security Testing as well as Infrastructure as Code scanning.
|
||||||
|
|
||||||
[[_TOC_]]
|
[[_TOC_]]
|
||||||
|
|
||||||
|
@ -7,9 +7,9 @@ This project provides componnets for the use of Static Application Security Test
|
||||||
|
|
||||||
### Documentation References
|
### Documentation References
|
||||||
|
|
||||||
Configuration for SAST can be performed through CI/CD Variables (https://docs.gitlab.com/ee/ci/variables/index.html) or via the definition of Inputs (https://docs.gitlab.com/ci/inputs/).
|
Configuration for SAST can be performed through [CI/CD Variables](https://docs.gitlab.com/ee/ci/variables/index.html) or via the definition of [Inputs](https://docs.gitlab.com/ci/inputs/).
|
||||||
|
|
||||||
More information about GitLab SAST is available within GitLab documentation (https://docs.gitlab.com/ee/user/application_security/sast/), along with the available variables (https://docs.gitlab.com/ee/user/application_security/sast/index.html#available-cicd-variables).
|
More information about GitLab SAST is available within [GitLab documentation](https://docs.gitlab.com/ee/user/application_security/sast/), along with the [available variables](https://docs.gitlab.com/ee/user/application_security/sast/index.html#available-cicd-variables).
|
||||||
|
|
||||||
### Usage
|
### Usage
|
||||||
|
|
||||||
|
@ -18,7 +18,7 @@ keyword.
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
include:
|
include:
|
||||||
- component: gitlab.com/components/sast/sast@<VERSION> # To include SAST Scanning
|
- component: gitlab.com/components/sast/sast@<VERSION>
|
||||||
```
|
```
|
||||||
|
|
||||||
where `<VERSION>` is the latest released tag or `main`.
|
where `<VERSION>` is the latest released tag or `main`.
|
||||||
|
@ -57,9 +57,9 @@ This assumes `SAST_DISABLED` variable is already defined in `.gitlab-ci.yml` wit
|
||||||
|
|
||||||
### Documentation References
|
### Documentation References
|
||||||
|
|
||||||
Configuration for IaC scanning can be performed through CI/CD Variables (https://docs.gitlab.com/ee/ci/variables/index.html) or via the definition of Inputs (https://docs.gitlab.com/ci/inputs/).
|
Configuration for IaC scanning can be performed through [CI/CD Variables](https://docs.gitlab.com/ee/ci/variables/index.html) or via the definition of [Inputs](https://docs.gitlab.com/ci/inputs/).
|
||||||
|
|
||||||
More information about GitLab Infrastructure as Code scanning is available within GitLab documentation (https://docs.gitlab.com/user/application_security/iac_scanning/).
|
More information about GitLab Infrastructure as Code scanning is available within [GitLab documentation](https://docs.gitlab.com/user/application_security/iac_scanning/).
|
||||||
|
|
||||||
### Usage
|
### Usage
|
||||||
|
|
||||||
|
@ -68,7 +68,7 @@ keyword.
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
include:
|
include:
|
||||||
- component: gitlab.com/components/sast/kics-iac-sast@<VERSION> # To include IaC Scanning
|
- component: gitlab.com/components/sast/iac-sast@<VERSION>
|
||||||
```
|
```
|
||||||
|
|
||||||
where `<VERSION>` is the latest released tag or `main`.
|
where `<VERSION>` is the latest released tag or `main`.
|
||||||
|
@ -79,13 +79,11 @@ where `<VERSION>` is the latest released tag or `main`.
|
||||||
| ----- | ------------- | ----------- |
|
| ----- | ------------- | ----------- |
|
||||||
| `stage` | `test` | The stage where you want the job to be added |
|
| `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_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_tag` | `6` | Tag of the Docker image to use |
|
||||||
| `image_suffix` | `""` | Suffix added to image. |
|
| `image_suffix` | `""` | Suffix added to image. |
|
||||||
| `excluded_paths` | `"spec, test, tests, tmp"` | Comma separated list of paths to exclude |
|
| `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 |
|
| `search_max_depth` | `4` | Defines how many directory levels the search for programming languages should span |
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Contribute
|
## Contribute
|
||||||
|
|
||||||
Please read about CI/CD components and best practices at: https://docs.gitlab.com/ee/ci/components
|
Please read about CI/CD components and best practices at: https://docs.gitlab.com/ee/ci/components
|
||||||
|
|
|
@ -5,7 +5,7 @@ spec:
|
||||||
image_prefix:
|
image_prefix:
|
||||||
default: "$CI_TEMPLATE_REGISTRY_HOST/security-products"
|
default: "$CI_TEMPLATE_REGISTRY_HOST/security-products"
|
||||||
image_tag:
|
image_tag:
|
||||||
default: '5'
|
default: '6'
|
||||||
image_suffix:
|
image_suffix:
|
||||||
default: ""
|
default: ""
|
||||||
excluded_analyzers:
|
excluded_analyzers:
|
||||||
|
@ -53,8 +53,14 @@ gitlab-advanced-sast:
|
||||||
image:
|
image:
|
||||||
name: "$[[ inputs.image_prefix ]]/gitlab-advanced-sast:${SAST_ANALYZER_IMAGE_TAG}$[[ inputs.image_suffix ]]"
|
name: "$[[ inputs.image_prefix ]]/gitlab-advanced-sast:${SAST_ANALYZER_IMAGE_TAG}$[[ inputs.image_suffix ]]"
|
||||||
variables:
|
variables:
|
||||||
SAST_ANALYZER_IMAGE_TAG: 1
|
SAST_ANALYZER_IMAGE_TAG: 2
|
||||||
SEARCH_MAX_DEPTH: 20
|
SEARCH_MAX_DEPTH: 20
|
||||||
|
cache:
|
||||||
|
key: "scan-metrics-$CI_COMMIT_REF_SLUG"
|
||||||
|
fallback_keys:
|
||||||
|
- "scan-metrics-$CI_DEFAULT_BRANCH"
|
||||||
|
paths:
|
||||||
|
- "scan_metrics.csv"
|
||||||
rules:
|
rules:
|
||||||
- if: '"$[[ inputs.excluded_analyzers ]]" =~ /gitlab-advanced-sast/'
|
- if: '"$[[ inputs.excluded_analyzers ]]" =~ /gitlab-advanced-sast/'
|
||||||
when: never
|
when: never
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue