Vue d'ensemble

Description

La commande secret scan est le point d'entrée pour la détection de secrets avec ggshield.

ggshield secret scan [OPTIONS] <SUBCOMMAND> [ARGS]...

Options

Elle prend en charge quelques options qui peuvent être utilisées pour adapter le comportement de la sortie.

• --json : produit les résultats en JSON [par défaut : false]
• --show-secrets : affiche les secrets en clair au lieu de les masquer.
• --exit-zero : retourne toujours un code de statut 0 (non-erreur), même si des incidents sont trouvés. La variable d'environnement GITGUARDIAN_EXIT_ZERO peut également être utilisée pour définir cette option.
• -v, --verbose : mode d'affichage verbeux.
• -o, --output <PATH> : route la sortie ggshield vers un fichier.
• -b, --banlist-detector <TEXT> : exclut les résultats d'un détecteur.
• --exclude <PATH> : ne scanne pas les chemins qui correspondent aux patterns glob spécifiés.
• --ignore-known-secrets : ignore les secrets déjà détectés en post-receive et donc connus de votre tableau de bord GitGuardian. [par défaut : False]
  Nous recommandons fortement de ne pas utiliser cette option en mode CI (ggshield secret scan ci) car les conditions de course affecteront la détection.

Options globales ggshield

• -h, --help : affiche l'aide détaillée

Sous-commandes

La commande peut être utilisée avec plusieurs sous-commandes selon les données à scanner.

• ggshield secret scan archive
• ggshield secret scan ci
• ggshield secret scan commit-range
• ggshield secret scan docker
• ggshield secret scan docset
• ggshield secret scan path
• ggshield secret scan pre-commit
• ggshield secret scan pre-push
• ggshield secret scan pre-receive
• ggshield secret scan pypi
• ggshield secret scan repo
• ggshield secret scan ai-hook

Divulgation du chemin Vault

Lorsque ggshield détecte un secret stocké dans l'un de vos vaults intégrés, il peut afficher l'emplacement précis du vault pour aider les développeurs à remédier plus rapidement aux fuites. Comment ça fonctionne : pendant un scan, ggshield vérifie vos vaults configurés (par exemple HashiCorp Vault, AWS Secrets Manager, Azure Key Vault) et, si une correspondance est trouvée, affiche :

• Nom du vault : quel secrets manager contient le secret
• Chemin du secret : l'emplacement exact dans le vault
• Type d'environnement : les chemins de production en premier, puis staging et development

Pour l'activer, naviguez vers Settings → General → Show vault path in ggshield