ggshield v1.53.0
Erkenne 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.
ggshield: schützen Sie Ihren Code mit GitGuardian
ggshield ist eine CLI-Anwendung, die in Ihrer lokalen Umgebung oder in einer CI-Umgebung läuft, um Ihnen zu helfen, mehr als 500+ Arten von Geheimnissen zu erkennen.
ggshield nutzt unsere öffentliche API über py-gitguardian, um Dateien und andere Textinhalte zu scannen und potenzielle Schwachstellen zu erkennen.
Bei Scans mit ggshield werden nur Metadaten wie Aufrufzeit, Anfragegröße und Scanmodus gespeichert. Daher werden Geheimnisse nicht in Ihrem Dashboard angezeigt und Ihre Dateien und Geheimnisse werden nicht gespeichert.
Inhaltsverzeichnis
- Installation
- Ersteinrichtung
- Erste Schritte
- Integrationen
- Weitere Informationen
- Ausgabe
- Verwandte Open-Source-Projekte
- Lizenz
Installation
Installationsskript (Empfohlen)
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-Arbeitsbereich oder eine selbstgehostete 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 Informationen zur Deinstallation.
Die folgenden Methoden installieren die CLI stattdessen manuell.
macOS
Homebrew
Sie können ggshield mit Homebrew installieren:
brew install ggshield
Updates werden von Homebrew verwaltet.
Standalone .pkg-Paket
Alternativ können Sie ein standalone .pkg-Paket von der ggshield-Release-Seite herunterladen und installieren.
Dieses Paket erfordert keine Installation von Python, aber Sie müssen neue Versionen manuell herunterladen.
Linux
Deb- und RPM-Pakete
Deb- und RPM-Pakete sind auf Cloudsmith verfügbar.
Einrichtungsanleitungen:
Updates werden vom Paketmanager verwaltet.
Windows
Chocolatey
ggshield ist über den Chocolatey-Paketmanager verfügbar:
choco install ggshield
MSI-Installer
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
Standalone .zip-Archiv
Wir stellen ein standalone .zip-Archiv auf der ggshield-Release-Seite bereit.
Entpacken Sie das Archiv auf Ihrer Festplatte und fügen Sie das Verzeichnis mit der ggshield.exe-Datei zu %PATH% hinzu.
Dieses Archiv erfordert keine Installation von Python, aber Sie müssen neue Versionen manuell herunterladen.
Alle Betriebssysteme
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 für standalone Pakete) und git.
Wenn Sie keine unserer paketierten Versionen von ggshield verwenden, beachten Sie bitte, dass wir dem Python-Release-Zyklus folgen und keine Versionen unterstützen, die das EOL erreicht haben.
Mittels pipx
Die empfohlene Methode zur Installation von ggshield von PyPI ist die Verwendung von pipx. Dadurch wird es in einer isolierten Umgebung installiert:
pipx install ggshield
Um Ihre Installation zu aktualisieren, führen Sie folgenden Befehl aus:
pipx upgrade ggshield
Mittels pip
Sie können ggshield auch mit pip von PyPI installieren, dies wird jedoch nicht empfohlen, da die Installation nicht isoliert ist und andere auf diese Weise installierte Anwendungen oder Pakete Ihre ggshield-Installation beeinträchtigen können. Diese Methode funktioniert auch nicht, wenn Ihre Python-Installation als extern verwaltet deklariert ist (z. B. bei Verwendung des systemeigenen Python auf Betriebssystemen wie Debian 12):
pip install --user ggshield
Um Ihre Installation zu aktualisieren, führen Sie folgenden Befehl aus:
pip install --user --upgrade ggshield
Ersteinrichtung
Mit ggshield auth login
Um ggshield zu verwenden, müssen Sie sich gegenüber den GitGuardian-Servern authentifizieren. Verwenden Sie dazu den Befehl ggshield auth login. Dieser Befehl automatisiert die Bereitstellung eines persönlichen Zugriffstokens und dessen Konfiguration auf der lokalen Workstation.