atlassian/git-secrets-scanСканирует репозитории Git на наличие жёстко закодированных секретов, ключей и паролей с помощью Gitleaks, интегрируя безопасность в Bitbucket Pipelines с отчётами Code Insights.
Сканирует ваши файлы на наличие жёстко закодированных секретов, ключей и паролей. При обнаружении создаёт отчёт о безопасности Code Insights.
Этот Pipe, поддерживаемый Bitbucket Cloud, использует реестр шаблонов секретов gitleaks, чтобы предоставить клиентам Bitbucket передовые в отрасли возможности сканирования секретов безопасности. Дополнительную информацию см. в разделе «Детали и примеры».
Примечание: в версии 2.0.0 были внесены критические изменения. Перед обновлением ознакомьтесь с текущей версией Pipe и соответствующим образом обновите конфигурацию.
Примечание: в версии 3.0.0 были внесены критические изменения. Перед обновлением ознакомьтесь с текущей версией Pipe и соответствующим образом обновите конфигурацию.
Добавьте следующий фрагмент в раздел script вашего файла bitbucket-pipelines.yml:
- pipe: atlassian/git-secrets-scan:3.2.0
variables:
# GITLEAKS_COMMAND: '<string>' # Optional. Default: `git`
# GITLEAKS_EXTRA_ARGS: '<array>' # Optional.
# CREATE_REPORT: "<boolean>" # Optional. Default: `true`
# DEBUG: "<boolean>" # Optional. Default: `false`
| Переменная | Использование |
|---|---|
| GITLEAKS_COMMAND | Команда для использования с gitleaks. Доступны: git, dir, stdin. По умолчанию: git. |
| GITLEAKS_EXTRA_ARGS | Дополнительные флаги для передачи в gitleaks gitleaks extra args. |
| CREATE_REPORT | Управляет тем, будет ли pipe создавать отчёты Bitbucket CodeInsights на основе результатов выполнения gitleaks. По умолчанию: true. |
| DEBUG | Включить дополнительную отладочную информацию. По умолчанию: false. |
По умолчанию pipe сканирует ваши файлы на наличие жёстко закодированных секретных учётных данных с помощью команды gitleaks git и
создаёт отчёт о безопасности с аннотациями для каждой найденной учётной записи.
Ознакомьтесь с этим сообщением в блоге о расширенной настройке gitleaks: gitleaks advanced configuration setup.
Как игнорировать тестовые секреты: gitleaks additional-configuration.
Запустите сканирование на наличие секретных учётных данных с помощью команды git по умолчанию:
script:
- pipe: atlassian/git-secrets-scan:3.2.0
Команда dir позволяет сканировать каталоги и файлы:
script:
- pipe: atlassian/git-secrets-scan:3.2.0
variables:
GITLEAKS_COMMAND: "dir"
GITLEAKS_EXTRA_ARGS: "./path_to_directory_or_file"
Не создавайте отчёт CodeInsights:
script:
- pipe: atlassian/git-secrets-scan:3.2.0
variables:
CREATE_REPORT: "false"
Сканирование каталогов и файлов, указание пользовательской конфигурации gitleaks и включение режима отладки:
script:
- pipe: atlassian/git-secrets-scan:3.2.0
variables:
DEBUG: "true"
GITLEAKS_COMMAND: "dir"
GITLEAKS_EXTRA_ARGS:
- "./path_to_directory_or_file"
- "--config=my-gitleaks-config.toml"
Если вам нужна помощь с этим pipe, или у вас возникла проблема или запрос на новую функцию, сообщите нам в Community.
Если вы сообщаете о проблеме, пожалуйста, укажите:
Copyright (c) 2020 Atlassian and others. Лицензировано по Apache 2.0, см. файл LICENSE.txt.