Talisman

Un outil pour détecter et empêcher les secrets d'être commités

Table des matières

• Qu'est-ce que Talisman ?
• Installation
  • Installation dans le PATH (approche recommandée)
  • Installation en tant que modèle de hook global
• Configuration d'un projet
  • Utilisation avec des frameworks de hooks
    • Pre-commit
    • Husky
  • Invocation directe de talisman
• Mise à niveau
• Talisman en action
  • Validations
  • Ignorer des fichiers
    • Mode interactif
    • Ignorer des détecteurs spécifiques
    • Ignorer des mots-clés spécifiques
    • Ignorer plusieurs fichiers du même type (avec des wildcards)
    • Ignorer des fichiers en spécifiant un périmètre de langage
    • Motifs de recherche personnalisés
  • Configuration du seuil de sévérité
  • Talisman en tant qu'utilitaire CLI
    • Mode interactif
    • Analyseur d'historique Git
    • Calculateur de somme de contrôle
• Rapport HTML Talisman
  • Captures d'écran
• Désinstallation
  • Désinstallation d'un modèle de hook global
  • Désinstallation d'un seul dépôt
• Contribuer à Talisman

Qu'est-ce que Talisman ?

Talisman est un outil qui analyse les ensembles de modifications Git pour garantir que les secrets potentiels ou les informations sensibles ne quittent pas le poste de travail du développeur.

Il valide l'ensemble de modifications sortant pour détecter des éléments suspects – comme des clés SSH potentielles, des jetons d'autorisation, des clés privées, etc.

Installation

Talisman prend en charge MAC OSX, Linux et Windows.

Talisman peut être installé et utilisé de l'une des manières suivantes :

1. En tant qu'exécutable autonome
2. En tant que hook Git comme modèle de hook Git global et utilitaire CLI (pour l'analyse des dépôts Git)
3. En tant que hook Git dans un seul dépôt Git

Talisman peut être configuré comme un hook pre-commit ou pre-push sur les dépôts Git.

Vous trouverez les instructions ci-dessous.

Avertissement : Les secrets qui s'infiltrent via un push forcé dans un dépôt Git ne peuvent pas être détectés par Talisman. Un push forcé est considéré comme notoire à sa manière, et nous suggérons aux administrateurs de dépôts Git de prendre les mesures appropriées pour autoriser de telles activités.

Installation dans le PATH (approche recommandée)

Nous recommandons d'installer talisman dans votre PATH afin qu'il soit disponible pour les frameworks de hooks Git et les scripts. Choisissez le binaire correct pour votre système depuis notre page des versions, ou exécutez notre script d'installation :```bash bash -c "$(curl --silent https://raw.githubusercontent.com/thoughtworks/talisman/main/install.sh)"

Ou définissez la variable d'environnement `INSTALL_LOCATION` pour spécifier un emplacement personnalisé pour le binaire :```bash
INSTALL_LOCATION=/usr/local/bin bash -c "$(curl --silent https://raw.githubusercontent.com/thoughtworks/talisman/main/install.sh)"

Ou définissez la variable d'environnement VERSION sur un tag de version publiée pour installer une version spécifique::```bash VERSION=v1.36.0 bash -c "$(curl --silent https://raw.githubusercontent.com/thoughtworks/talisman/main/install.sh)"

Ou en utilisant linuxbrew sous Linux et homebrew sous macOS en exécutant la commande suivante dans le terminal:```bash
brew install talisman

Installation en tant que modèle de hook global

Nous proposons des scripts qui installeront Talisman en tant que modèle de hook git pre-commit, car cela fera en sorte que Talisman soit présent, non seulement dans vos dépôts git existants, mais aussi dans tout nouveau dépôt que vous 'init' ou 'clonez'.

1. Exécutez la commande suivante sur votre terminal, pour télécharger et installer le binaire dans $HOME/.talisman/bin

En tant que hook pre-commit : ``` bash -c "$(curl --silent https://raw.githubusercontent.com/thoughtworks/talisman/main/global_install_scripts/install.bash)"

OU

  En tant que pre-push hook:  ```
bash -c "$(curl --silent https://raw.githubusercontent.com/thoughtworks/talisman/main/global_install_scripts/install.bash)" -- pre-push

2. Si vous n'avez pas configuré TALISMAN_HOME dans votre $PATH, il vous sera demandé un endroit approprié pour le configurer. Choisissez le numéro de l'option où vous avez défini la source du profil sur votre machine.

N'oubliez pas d'exécuter source sur le fichier de chemin ou de redémarrer votre terminal. Si vous choisissez de définir $PATH plus tard, veuillez exporter TALISMAN_HOME=$HOME/.talisman/bin vers le chemin.

3. Choisissez un répertoire de base où Talisman doit scanner tous les dépôts git, et configurez un hook git (pre-commit ou pre-push, comme choisi à l'étape 1) en tant que lien symbolique. Ce script n'écrasera pas les hooks existants. Si vous avez des hooks existants, vous pouvez ajouter Talisman via un framework de hooks

• vous pouvez définir la variable d'environnement SEARCH_ROOT avec le chemin du répertoire de base avant d'exécuter l'installation, afin de ne pas avoir à le saisir manuellement pendant l'installation

Configuration d'un projet

Utilisation avec des frameworks de hooks

Installer globalement talisman en tant que hook n'écrasera aucun hook existant. Si le script d'installation trouve des hooks existants, il se contentera de l'indiquer dans la console. Pour exécuter plusieurs hooks, nous suggérons d'utiliser un framework de hooks, tel que pre-commit ou husky. Ces instructions supposent que l'exécutable talisman est installé quelque part dans le chemin de votre système.

Pre-commit

Utilisez pre-commit pour gérer les hooks existants avec Talisman. Référencez notre pre-commit-hooks dans votre .pre-commit-config.yaml:```yaml

• repo: https://github.com/thoughtworks/talisman rev: 'v1.32.2' # Update me! hooks:

  both pre-commit and pre-push supported

  - id: talisman-push

  • id: talisman-commit

### Husky