Aller au contenu principal

ggshield hmsl fingerprint

Description

Collecter les secrets et calculer les empreintes.

ggshield hmsl fingerprint [OPTIONS] PATH

Les empreintes seront utilisées plus tard par la commande decrypt.

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

Options

  • -p, --prefix PREFIX : préfixe pour les noms de fichiers de sortie. Par exemple -p foo produit foo-payload.txt et foo-mapping.txt.

    Par défaut : "".

  • -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

Créez un fichier, par exemple secrets.txt, contenant quelques secrets :

sup3rstr0ngpass1ForGG
hjshnk5ex5u34565AWS654/JKGjhz545d89sjkja
hjshmq1no2v59001AWS792/PMDaax001t52sjkja

Nous avons ici deux mots de passe « non sécurisés » et une clé d'API GitGuardian (invalide).

La première étape consiste à calculer toutes les données dont nous aurons besoin dans les deux autres étapes :

$ ggshield hmsl fingerprint secrets.txt
payload.txt and mapping.txt files have been written.
Prepared 3 secrets.

Cette commande produit deux fichiers : payload.txt et mapping.txt. Le premier contient les préfixes qui seront interrogés sur HMSL, et le second une association entre les hashes de vos secrets et leurs « noms », une version censurée de leurs valeurs plus lisible pour les humains.