gitguardian/ggshieldОбнаруживайте и проверяйте более 500 типов жёстко заданных секретов с помощью расширенных проверок. Используйте его как pre-commit hook, GitHub Action или CLI для проактивного обнаружения секретов и обеспечения безопасности.
[!IMPORTANT] macOS: обновление до версии 1.54.0 вызывает запрос Keychain для
ggshield-py— второго бинарного файла, который теперь считывает ваш сохранённый токен в рамках наших улучшений производительности. Нажмите Always Allow; больше он не спросит.
ggshield — это CLI-приложение, которое запускается в вашей локальной среде или в среде CI и помогает обнаруживать более 500 типов секретов.
ggshield использует наш публичный API через py-gitguardian для сканирования и обнаружения потенциальных уязвимостей в файлах и другом текстовом содержимом.
При сканированиях с помощью ggshield сохраняются только метаданные, такие как время вызова, размер запроса и режим сканирования, поэтому секреты не будут отображаться на вашей панели управления, а ваши файлы и секреты не будут сохранены.
Самый быстрый способ установить ggshield.
Linux / macOS:
curl -sSfL \
https://raw.githubusercontent.com/GitGuardian/ggshield/main/scripts/install/install.sh | bash
Windows (PowerShell):
irm https://raw.githubusercontent.com/GitGuardian/ggshield/main/scripts/install/install.ps1 | iex
Или, если вы предпочитаете curl (входит в состав Windows 10+):
curl.exe -sSL https://raw.githubusercontent.com/GitGuardian/ggshield/main/scripts/install/install.ps1 | powershell -NoProfile -ExecutionPolicy Bypass -Command -
Скрипт принимает такие параметры, как --instance и --plugin (установить
плагин). Для рабочего пространства EU или самостоятельно размещённого экземпляра задайте
переменную окружения GITGUARDIAN_INSTANCE (или передайте --instance <URL>)
перед запуском.
Полный список параметров, другие способы установки и инструкции по удалению см. в
scripts/install/README.md.
Приведённые ниже способы устанавливают CLI вручную.
Вы можете установить ggshield с помощью Homebrew:
brew install ggshield
Обновление выполняется средствами Homebrew.
В качестве альтернативы вы можете скачать и установить автономный пакет .pkg со страницы релизов ggshield.
Этот пакет не требует установки Python, но новые версии придётся скачивать вручную.
Пакеты Deb и RPM доступны на Cloudsmith.
Инструкции по настройке:
Обновление выполняется средствами менеджера пакетов.
ggshield доступен через менеджер пакетов Chocolatey:
choco install ggshield
Скачайте установщик MSI со страницы релизов ggshield и установите его:
msiexec /i ggshield-VERSION-x86_64-pc-windows-msvc.msi
Мы предоставляем автономный архив .zip на странице релизов ggshield.
Распакуйте архив на диск, затем добавьте каталог, содержащий файл ggshield.exe, в %PATH%.
Этот архив не требует установки Python, но новые версии придётся скачивать вручную.
ggshield можно установить во всех поддерживаемых операционных системах через его пакет PyPI.
Требуется поддерживаемая версия Python (не EOL) (кроме автономных пакетов) и git.
Если вы не используете наши упакованные версии ggshield, учтите, что мы следуем циклу выпуска Python и не поддерживаем версии, достигшие EOL.
Рекомендуемый способ установки ggshield из PyPI — использовать pipx, который установит его в изолированное окружение:
pipx install ggshield
Чтобы обновить установку, выполните:
pipx upgrade ggshield
Вы также можете установить ggshield из PyPI с помощью pip, но это не рекомендуется, поскольку установка не изолирована, поэтому другие приложения или пакеты, установленные таким образом, могут повлиять на вашу установку ggshield. Этот способ также не сработает, если ваша установка Python объявлена как externally managed (например, при использовании системного Python в таких операционных системах, как Debian 12):
pip install --user ggshield
Чтобы обновить установку, выполните:
pip install --user --upgrade ggshield
ggshield auth loginЧтобы использовать ggshield, необходимо пройти аутентификацию на серверах GitGuardian. Для этого используйте команду ggshield auth login. Эта команда автоматизирует создание персонального токена доступа и его настройку на локальной рабочей станции.
Подробнее об этом можно узнать в документации ggshield auth login.