niclas-zone/ci/gitleaksКомпонент CI для инструмента SAST Gitleaks, который сканирует git-репозитории на наличие жестко закодированных секретов, ключей API и токенов с поддержкой пользовательской и удаленной конфигурации.
Компонент GitLab CI для Gitleaks — инструмента SAST для обнаружения и предотвращения жёстко закодированных секретов, таких как пароли, ключи API и токены, в git-репозиториях.
include:
- component: $CI_SERVER_FQDN/niclas-zone/ci/gitleaks/main@latest
stages:
- test
include:
- component: $CI_SERVER_FQDN/niclas-zone/ci/gitleaks/main@latest
inputs:
GITLEAKS_CONFIG: ".gitleaks.toml"
GITLEAKS_EXTRA_ARGS: "--verbose --report-format sarif"
stages:
- test
include:
- component: $CI_SERVER_FQDN/niclas-zone/ci/gitleaks/main@latest
inputs:
GITLEAKS_REMOTE_CONFIG: "https://gitlab.com/niclas-zone/ci/gitleaks/-/raw/main/configs/gitleaks.toml"
stages:
- test
| Input | Описание | Значение по умолчанию |
|---|---|---|
job_name | Имя задачи CI | "secret scanning" |
stage | Этап конвейера | "test" |
image | Docker-образ для Gitleaks | "registry.gitlab.com/niclas-zone/ctr/gitleaks:8.28.0" |
GITLEAKS_EXTRA_ARGS | Дополнительные аргументы для Gitleaks | "--verbose --redact --report-format json" |
GITLEAKS_CONFIG | Путь к локальному файлу конфигурации | "" |
GITLEAKS_REMOTE_CONFIG | URL для загрузки файла конфигурации | "" |
Поместите файл .gitleaks.toml в корень вашего репозитория или укажите путь с помощью GITLEAKS_CONFIG.
Установите GITLEAKS_REMOTE_CONFIG, чтобы загрузить файл конфигурации из URL. Это удобно для совместного использования конфигураций в нескольких проектах.
Если не указана ни локальная, ни удалённая конфигурация, компонент будет использовать встроенные правила Gitleaks по умолчанию.
Компонент генерирует следующие артефакты:
gitleaks-report.json: Результаты сканирования в формате JSON (или другом формате в зависимости от аргумента --report-format)Для получения дополнительной информации о конфигурации и параметрах Gitleaks см.: