gitguardian/ggshieldRileva e convalida oltre 500 tipi di segreti hardcoded con controlli avanzati. Usalo come pre-commit hook, GitHub Action o CLI per la rilevazione proattiva di segreti e la sicurezza.
[!IMPORTANT] macOS: l'aggiornamento alla versione 1.54.0 attiva una richiesta del Portachiavi per
ggshield-py, un secondo binario che ora legge il token salvato come parte dei nostri miglioramenti delle prestazioni. Fai clic su Consenti sempre; non lo chiederà più.
ggshield è un'applicazione CLI che viene eseguita nel tuo ambiente locale o in un ambiente CI per aiutarti a rilevare più di 500 tipi di segreti.
ggshield utilizza la nostra API pubblica tramite py-gitguardian per scansionare e rilevare potenziali vulnerabilità nei file e in altri contenuti testuali.
Dalle scansioni effettuate con ggshield vengono memorizzati solo metadati come l'ora della chiamata, la dimensione della richiesta e la modalità di scansione, pertanto i segreti non verranno visualizzati nella tua dashboard e i tuoi file e segreti non verranno memorizzati.
Il modo più rapido per installare 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
Oppure, se preferisci curl (incluso in Windows 10+):
curl.exe -sSL https://raw.githubusercontent.com/GitGuardian/ggshield/main/scripts/install/install.ps1 | powershell -NoProfile -ExecutionPolicy Bypass -Command -
Lo script accetta opzioni come --instance e --plugin (installa un
plugin). Per il workspace UE o un'istanza self-hosted, imposta la
variabile d'ambiente GITGUARDIAN_INSTANCE (o passa --instance <URL>)
prima dell'esecuzione.
Consulta scripts/install/README.md per l'elenco completo
delle opzioni, gli altri metodi di installazione e come disinstallare.
I metodi seguenti installano la CLI manualmente.
Puoi installare ggshield usando Homebrew:
brew install ggshield
L'aggiornamento è gestito da Homebrew.
In alternativa, puoi scaricare e installare un pacchetto .pkg standalone dalla pagina delle release di ggshield.
Questo pacchetto non richiede l'installazione di Python, ma devi scaricare manualmente le nuove versioni.
I pacchetti Deb e RPM sono disponibili su Cloudsmith.
Istruzioni di configurazione:
L'aggiornamento è gestito dal gestore di pacchetti.
ggshield è disponibile tramite il gestore di pacchetti Chocolatey:
choco install ggshield
Scarica il programma di installazione MSI dalla pagina delle release di ggshield e installalo:
msiexec /i ggshield-VERSION-x86_64-pc-windows-msvc.msi
Forniamo un archivio .zip standalone sulla pagina delle release di ggshield.
Estrai l'archivio sul tuo disco, quindi aggiungi la directory contenente il file ggshield.exe al %PATH%.
Questo archivio non richiede l'installazione di Python, ma devi scaricare manualmente le nuove versioni.
ggshield può essere installato su tutti i sistemi operativi supportati tramite il suo pacchetto PyPI.
Richiede una versione supportata di Python (non EOL) (tranne che per i pacchetti standalone) e git.
Se non utilizzi le nostre versioni pacchettizzate di ggshield, tieni presente che seguiamo il ciclo di rilascio di Python e non supportiamo le versioni che hanno raggiunto l'EOL.
Il modo consigliato per installare ggshield da PyPI è usare pipx, che lo installerà in un ambiente isolato:
pipx install ggshield
Per aggiornare la tua installazione, esegui:
pipx upgrade ggshield
Puoi anche installare ggshield da PyPI usando pip, ma questo non è consigliato perché l'installazione non è isolata, quindi altre applicazioni o pacchetti installati in questo modo potrebbero influire sulla tua installazione di ggshield. Questo metodo inoltre non funzionerà se la tua installazione di Python è dichiarata come gestita esternamente (ad esempio quando si utilizza il Python di sistema su sistemi operativi come Debian 12):
pip install --user ggshield
Per aggiornare la tua installazione, esegui:
pip install --user --upgrade ggshield
ggshield auth login