Talisman

Ein Werkzeug, um Geheimnisse zu erkennen und zu verhindern, dass sie eingecheckt werden

Inhaltsverzeichnis

• Was ist Talisman?
• Installation
  • Installation in den Pfad (empfohlener Ansatz)
  • Installation als globale Hook-Vorlage
• Konfiguration eines Projekts
  • Verwendung mit Hook-Frameworks
    • Pre-commit
    • Husky
  • Direktes Aufrufen von Talisman
• Aktualisierung
• Talisman in Aktion
  • Validierungen
  • Ignorieren von Dateien
    • Interaktiver Modus
    • Ignorieren bestimmter Detektoren
    • Ignorieren bestimmter Schlüsselwörter
    • Ignorieren mehrerer Dateien desselben Typs (mit Platzhaltern)
    • Ignorieren von Dateien durch Angabe des Sprachbereichs
    • Benutzerdefinierte Suchmuster
  • Konfiguration des Schweregradschwellenwerts
  • Talisman als CLI-Dienstprogramm
    • Interaktiver Modus
    • Git-Verlaufsscanner
    • Prüfsummenrechner
• Talisman HTML-Berichte
  • Beispiel-Screenshots
• Deinstallation
  • Deinstallation von einer globalen Hook-Vorlage
  • Deinstallation von einem einzelnen Repository
• Beiträge zu Talisman

Was ist Talisman?

Talisman ist ein Werkzeug, das Git-Änderungssätze scannt, um sicherzustellen, dass potenzielle Geheimnisse oder sensible Informationen die Entwicklerworkstation nicht verlassen.

Es validiert den ausgehenden Änderungssatz auf verdächtige Dinge – wie potenzielle SSH-Schlüssel, Autorisierungstoken, private Schlüssel usw.

Installation

Talisman unterstützt MAC OSX, Linux und Windows.

Talisman kann auf eine der folgenden Arten installiert und verwendet werden:

1. Als eigenständige ausführbare Datei
2. Als Git-Hook als globale Git-Hook-Vorlage und CLI-Dienstprogramm (für Git-Repo-Scannen)
3. Als Git-Hook in einem einzelnen Git-Repository

Talisman kann als Pre-Commit- oder Pre-Push-Hook in den Git-Repositories eingerichtet werden.

Die Anweisungen finden Sie unten.

Haftungsausschluss: Geheimnisse, die durch einen erzwungenen Push in ein Git-Repository gelangen, können von Talisman nicht erkannt werden. Ein erzwungener Push gilt auf seine Weise als berüchtigt, und wir empfehlen Git-Repository-Administratoren, geeignete Maßnahmen zu ergreifen, um solche Aktivitäten zu autorisieren.

Installation in den Pfad (empfohlener Ansatz)

Wir empfehlen, talisman in Ihren Pfad zu installieren, sodass es für Git-Hook-Frameworks und Skripte verfügbar ist. Wählen Sie das richtige Binärprogramm für Ihr System von unserer Release-Seite aus oder führen Sie unser Installationsskript aus:```bash bash -c "$(curl --silent https://raw.githubusercontent.com/thoughtworks/talisman/main/install.sh)"

Oder setzen Sie die Umgebungsvariable `INSTALL_LOCATION` zur Angabe eines benutzerdefinierten Speicherorts für die Binärdatei:```bash
INSTALL_LOCATION=/usr/local/bin bash -c "$(curl --silent https://raw.githubusercontent.com/thoughtworks/talisman/main/install.sh)"

Oder setze die Umgebungsvariable VERSION auf einen veröffentlichten Tag, um eine bestimmte Version zu installieren::```bash VERSION=v1.36.0 bash -c "$(curl --silent https://raw.githubusercontent.com/thoughtworks/talisman/main/install.sh)"

Oder mit linuxbrew unter Linux und homebrew unter macOS, indem Sie den folgenden Befehl im Terminal ausführen:```bash
brew install talisman

Installation als globale Hook-Vorlage

Wir bieten Skripte an, die Talisman als Pre-commit-Git-Hook-Vorlage installieren, da dies dazu führt, dass Talisman nicht nur in Ihren bestehenden Git-Repositories, sondern auch in jedem neuen Repository, das Sie 'init' oder 'clone', vorhanden ist.

1. Führen Sie den folgenden Befehl in Ihrem Terminal aus, um die Binärdatei unter $HOME/.talisman/bin herunterzuladen und zu installieren.

Als Pre-commit-Hook: ``` bash -c "$(curl --silent https://raw.githubusercontent.com/thoughtworks/talisman/main/global_install_scripts/install.bash)"

ODER

  Als Pre-Push-Hook:  ```
bash -c "$(curl --silent https://raw.githubusercontent.com/thoughtworks/talisman/main/global_install_scripts/install.bash)" -- pre-push

2. Wenn Sie TALISMAN_HOME nicht in Ihrem $PATH eingerichtet haben, werden Sie nach einem geeigneten Ort gefragt, um es einzurichten. Wählen Sie die Optionsnummer, bei der Sie die Profil-Quelldatei auf Ihrem Rechner setzen.

Denken Sie daran, source auf die Pfad-Datei auszuführen oder Ihr Terminal neu zu starten. Wenn Sie sich entscheiden, den $PATH später zu setzen, exportieren Sie bitte TALISMAN_HOME=$HOME/.talisman/bin in den Pfad.

3. Wählen Sie ein Basisverzeichnis, in dem Talisman nach allen Git-Repositories scannen soll, und richten Sie einen Git-Hook (pre-commit oder pre-push, wie in Schritt 1 gewählt) als Symlink ein. Dieses Skript wird keine bereits vorhandenen Hooks überschreiben. Wenn Sie bestehende Hooks haben, können Sie Talisman über ein Hook-Framework hinzufügen.

• Sie können die Umgebungsvariable SEARCH_ROOT mit dem Pfad des Basisverzeichnisses setzen, bevor Sie die Installation ausführen, damit Sie es während der Installation nicht manuell eingeben müssen.

Konfiguration eines Projekts

Verwendung mit Hook-Frameworks

Die globale Installation von Talisman als Hook überschreibt keine vorhandenen Hooks. Wenn das Installationsskript vorhandene Hooks findet, zeigt es dies lediglich in der Konsole an. Um mehrere Hooks auszuführen, empfehlen wir die Verwendung eines Hook-Frameworks wie pre-commit oder husky. Diese Anweisungen setzen voraus, dass die ausführbare Talisman-Datei irgendwo im Pfad Ihres Systems installiert ist.

Pre-commit