Aller au contenu principal

ggshield hmsl check

Description

Vérifier si des secrets ont fuité.

ggshield hmsl check [OPTIONS] PATH

Note : les secrets peuvent être lus depuis stdin en utilisant ggshield hmsl check -.

Options

  • --format [text|json] : format à utiliser pour la sortie.

  • --json : raccourci pour --format json.

  • -f, --full-hashes : place les hashes complets dans la payload au lieu des préfixes. C'est utile pour les partenaires qui font confiance à GitGuardian car cela permet d'envoyer plus de hashes par lot et consomme moins de crédits.

  • -n, --naming-strategy [censored|cleartext|none|key] : stratégie pour générer les indices dans la sortie.

    • censored : seuls les premiers et derniers caractères sont affichés.
    • cleartext : le secret complet est utilisé comme indice (non recommandé !).
    • none : aucun indice n'est généré.
    • key : le nom de la clé est sélectionné si disponible (par exemple dans les fichiers .env), sinon censored est utilisé.

    Par défaut : key.

  • -t, --type [file|env] : type d'entrée à traiter.

    • file : l'entrée est un fichier texte contenant des secrets. Une ligne par secret.
    • env : l'entrée est un fichier contenant des variables d'environnement.

    Par défaut : file.

Cette commande prend en charge toutes les options globales ggshield.

Exemple

Étant donné un fichier secrets.txt contenant :

sup3rstr0ngpass1ForGG
hjshnk5ex5u34565AWS654/JKGjhz545d89sjkja
hjshmq1no2v59001AWS792/PMDaax001t52sjkja
$ ggshield hmsl check secrets.txt
Collecting secrets...
Collected 3 secrets.
Querying HasMySecretLeaked...
97 credits left for today.
Found 2 leaked secrets.

> Secret 1
Secret name: "hjshnk5**************************89sjkja"
Secret hash: "e9b39209f72228f30b60c19493a3f756ac97dc02ae7f52db2a3abbe3c3269339"
Distinct locations: 96
First occurrence:
URL: "https://github.com/ChrisJStone/gitflow-cjs/commit/1c9b5b4286361ee88d64305e5a0080f03570cc5e#diff-02557643ffc95ebd4d6d5a96c612319db32179d87b36cb1f78d2f4305c80b994R10"


> Secret 2
Secret name: "sup3*************orGG"
Secret hash: "d775db0302080c1b7516109e929dd4b214a0f353ed3b66ff2e56c47d55a102ed"
Distinct locations: 33
First occurrence:
URL: "https://github.com/akansha-nec/Sample2/commit/b06ae6b5e0869657faff9aef37fe2a1afc39370f#diff-9d6176320759464781692ac6ec7d84d987716bad52218e13ac3219c6004e630fR4"

Voici un exemple supplémentaire lorsque rien n'est trouvé :

$ ggshield hmsl check secrets2.txt
Collecting secrets...
Collected 1 secrets.
Querying HasMySecretLeaked...
99 credits left for today.
All right! No leaked secret has been found.