Aller au contenu principal

ggshield secret scan archive

Description​

Scanne un fichier archive. Les formats d'archive pris en charge sont zip, whl, jar, tar, tar.gz, tar.bz2 et tar.xz.

ggshield secret scan archive [OPTIONS] PATH

Options​

  • --source-uuid TEXT : Identifiant de la source personnalisée dans GitGuardian. S'il est utilisé, les incidents seront créés et visibles sur le dashboard. Nécessite le scope 'scan:create-incidents'.
  • --filename-only : Envoie uniquement le nom du fichier (pas le chemin complet) à GitGuardian, afin que les incidents n'enregistrent que le nom du fichier.
  • --all-secrets : N'ignore aucun secret. La raison d'ignorance possible est également affichée.
  • --instance URL : URL de l'instance à utiliser.
  • --with-incident-details : Affiche tous les détails concernant l'incident du dashboard s'il en existe un (formats JSON et SARIF uniquement). Nécessite le scope 'incidents:read'.
  • -b, --banlist-detector DETECTOR : Exclut les résultats d'un détecteur.
  • --ignore-known-secrets : Ignore les secrets déjà connus par le dashboard GitGuardian.
  • --exclude PATTERNS : Ne scanne pas les chemins qui correspondent aux motifs de type glob spécifiés.
  • --exit-zero : Retourne un code de statut 0 (sans erreur), même si des incidents sont trouvés. Un code de statut d'erreur sera tout de même retourné pour d'autres erreurs, telles que les erreurs de connexion. Cette option peut également être définie avec la variable d'environnement GITGUARDIAN_EXIT_ZERO.
  • --show-secrets : Affiche les secrets en texte clair au lieu de les masquer.
  • -o, --output PATH : Redirige la sortie de ggshield vers PATH.
  • --format [text|json|sarif] : Format à utiliser pour la sortie.
  • --json : Raccourci pour --format json.

Cette commande prend en charge toutes les options globales de ggshield.