gitguardian/ggshieldErkenne und validiere über 500 Arten von hartkodierten Geheimnissen mit erweiterten Prüfungen. Nutze es als Pre-Commit-Hook, GitHub Action oder CLI zur proaktiven Geheimniserkennung und Sicherheit.
[!IMPORTANT] macOS: Das Upgrade auf 1.54.0 löst eine Keychain-Abfrage für
ggshield-pyaus, eine zweite Binärdatei, die nun im Rahmen unserer Leistungsverbesserungen Ihr gespeichertes Token liest. Klicken Sie auf Immer erlauben; es wird nicht erneut gefragt.
ggshield ist eine CLI-Anwendung, die in Ihrer lokalen Umgebung oder in einer CI-Umgebung ausgeführt wird, um Ihnen zu helfen, mehr als 500+ Arten von Secrets zu erkennen.
ggshield verwendet unsere öffentliche API über py-gitguardian, um Dateien und andere Textinhalte auf potenzielle Schwachstellen zu scannen und zu erkennen.
Bei Scans mit ggshield werden nur Metadaten wie Aufrufzeit, Anfragegröße und Scanmodus gespeichert, daher werden Secrets nicht in Ihrem Dashboard angezeigt und Ihre Dateien und Secrets werden nicht gespeichert.
Der schnellste Weg, ggshield zu installieren.
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
Oder, wenn Sie curl bevorzugen (in Windows 10+ enthalten):
curl.exe -sSL https://raw.githubusercontent.com/GitGuardian/ggshield/main/scripts/install/install.ps1 | powershell -NoProfile -ExecutionPolicy Bypass -Command -
Das Skript akzeptiert Optionen wie --instance und --plugin (Installation eines
Plugins). Für den EU-Workspace oder eine selbst gehostete Instanz setzen Sie die
Umgebungsvariable GITGUARDIAN_INSTANCE (oder übergeben Sie --instance <URL>)
vor der Ausführung.
Siehe scripts/install/README.md für die vollständige Liste
der Optionen, die anderen Installationsmethoden und wie Sie deinstallieren können.
Die folgenden Methoden installieren die CLI stattdessen manuell.
Sie können ggshield mit Homebrew installieren:
brew install ggshield
Das Upgrade wird von Homebrew übernommen.
Alternativ können Sie ein eigenständiges .pkg-Paket von der ggshield-Release-Seite herunterladen und installieren.
Dieses Paket erfordert nicht die Installation von Python, aber Sie müssen neue Versionen manuell herunterladen.
Deb- und RPM-Pakete sind auf Cloudsmith verfügbar.
Einrichtungsanweisungen:
Das Upgrade wird vom Paketmanager übernommen.
ggshield ist über den Chocolatey-Paketmanager verfügbar:
choco install ggshield
Laden Sie den MSI-Installer von der ggshield-Release-Seite herunter und installieren Sie ihn:
msiexec /i ggshield-VERSION-x86_64-pc-windows-msvc.msi
Wir stellen ein eigenständiges .zip-Archiv auf der ggshield-Release-Seite bereit.
Entpacken Sie das Archiv auf Ihrer Festplatte und fügen Sie dann das Verzeichnis, das die Datei ggshield.exe enthält, zu %PATH% hinzu.
Dieses Archiv erfordert nicht die Installation von Python, aber Sie müssen neue Versionen manuell herunterladen.
ggshield kann auf allen unterstützten Betriebssystemen über sein PyPI-Paket installiert werden.
Es erfordert eine unterstützte Version von Python (nicht EOL) (außer bei eigenständigen Paketen) und git.
Wenn Sie nicht unsere paketierten Versionen von ggshield verwenden, beachten Sie bitte, dass wir dem Python-Release-Zyklus folgen und Versionen, die EOL erreicht haben, nicht unterstützen.
Der empfohlene Weg, ggshield von PyPI zu installieren, ist die Verwendung von pipx, das es in einer isolierten Umgebung installiert:
pipx install ggshield
Um Ihre Installation zu aktualisieren, führen Sie aus:
pipx upgrade ggshield
Sie können ggshield auch von PyPI mit pip installieren, aber dies wird nicht empfohlen, da die Installation nicht isoliert ist, sodass andere Anwendungen oder auf diese Weise installierte Pakete Ihre ggshield-Installation beeinträchtigen können. Diese Methode funktioniert auch nicht, wenn Ihre Python-Installation als extern verwaltet deklariert ist (zum Beispiel bei Verwendung des System-Python auf Betriebssystemen wie Debian 12):
pip install --user ggshield
Um Ihre Installation zu aktualisieren, führen Sie aus:
pip install --user --upgrade ggshield
ggshield auth login