Talisman

Uno strumento per rilevare e prevenire che i segreti vengano inseriti nel repository

Indice

• Cos'è Talisman?
• Installazione
  • Installa nel PATH (approccio consigliato)
  • Installazione come template globale di hook
• Configurazione di un progetto
  • Utilizzo con framework di hook
    • Pre-commit
    • Husky
  • Invocazione diretta di talisman
• Aggiornamento
• Talisman in azione
  • Validazioni
  • Ignorare i file
    • Modalità interattiva
    • Ignorare rilevatori specifici
    • Ignorare parole chiave specifiche
    • Ignorare più file dello stesso tipo (con wildcard)
    • Ignorare file specificando l'ambito del linguaggio
    • Pattern di ricerca personalizzati
  • Configurare la soglia di gravità
  • Talisman come utilità CLI
    • Modalità interattiva
    • Scanner della cronologia Git
    • Calcolatore di checksum
• Report HTML di Talisman
  • Esempi di schermate
• Disinstallazione
  • Disinstallazione da un template globale di hook
  • Disinstallazione da un singolo repository
• Contribuire a Talisman

Cos'è Talisman?

Talisman è uno strumento che scansiona i changeset git per garantire che potenziali segreti o informazioni sensibili non lascino la workstation dello sviluppatore.

Convalida il changeset in uscita per individuare elementi sospetti, come potenziali chiavi SSH, token di autorizzazione, chiavi private, ecc.

Installazione

Talisman supporta MAC OSX, Linux e Windows.

Talisman può essere installato e utilizzato in uno dei seguenti modi:

1. Come eseguibile autonomo
2. Come hook git come template globale di hook git e utilità CLI (per la scansione dei repository git)
3. Come hook git in un singolo repository git

Talisman può essere configurato come hook pre-commit o pre-push sui repository git.

Trova le istruzioni qui sotto.

Avvertenza: I segreti che si insinuano tramite un push forzato in un repository git non possono essere rilevati da Talisman. Un push forzato è considerato notoriamente problematico, e suggeriamo agli amministratori del repository git di adottare misure appropriate per autorizzare tali attività.

Installa nel PATH (approccio consigliato)

Ti consigliamo di installare talisman nel PATH in modo che sia disponibile per framework di hook git e script. Scegli il binario corretto per il tuo sistema dalla nostra Pagina delle Release, oppure esegui il nostro script di installazione:```bash bash -c "$(curl --silent https://raw.githubusercontent.com/thoughtworks/talisman/main/install.sh)"

Oppure imposta la variabile d'ambiente `INSTALL_LOCATION` per specificare una posizione personalizzata per il binario:```bash
INSTALL_LOCATION=/usr/local/bin bash -c "$(curl --silent https://raw.githubusercontent.com/thoughtworks/talisman/main/install.sh)"

Oppure imposta la variabile d'ambiente VERSION su un tag rilasciato per installare una versione specifica::```bash VERSION=v1.36.0 bash -c "$(curl --silent https://raw.githubusercontent.com/thoughtworks/talisman/main/install.sh)"

Oppure usando linuxbrew in Linux e homebrew in macOS eseguendo il seguente comando nel terminale:```bash
brew install talisman

Installazione come template di hook globale

Offriamo script che installeranno Talisman come template di hook git pre-commit, poiché ciò farà sì che Talisman sia presente non solo nei repository git esistenti, ma anche in qualsiasi nuovo repository che inizializzi ('init') o cloni ('clone').

1. Esegui il seguente comando nel tuo terminale, per scaricare e installare il binario in $HOME/.talisman/bin

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

O

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

2. Se non hai TALISMAN_HOME impostato nel tuo $PATH, ti verrà chiesto un luogo appropriato per impostarlo. Scegli il numero dell'opzione in cui imposti il source del profilo sulla tua macchina.

Ricorda di eseguire source sul file di percorso o riavviare il terminale. Se scegli di impostare il $PATH in seguito, esporta TALISMAN_HOME=$HOME/.talisman/bin nel path.

3. Scegli una directory di base dove Talisman deve scansionare tutti i repository git, e imposta un hook git (pre-commit o pre-push, come scelto al passo 1) come symlink. Questo script non sovrascriverà hook preesistenti. Se hai hook esistenti, puoi aggiungere talisman tramite un hook framework

• puoi impostare la variabile d'ambiente SEARCH_ROOT con il percorso della directory di base prima di eseguire l'installazione, in modo da non doverla inserire manualmente durante l'installazione

Configurare un progetto

Utilizzo con framework di hook

Installare globalmente talisman come hook non sovrascriverà alcun hook esistente. Se lo script di installazione trova hook esistenti, lo indicherà solo nella console. Per eseguire più hook, suggeriamo di utilizzare un hook framework, come pre-commit o husky. Queste istruzioni presuppongono che l'eseguibile talisman sia installato in qualche punto nel path del tuo sistema.

Pre-commit

Usa pre-commit per gestire gli hook esistenti insieme a Talisman. Fai riferimento ai nostri pre-commit-hooks nel tuo .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

[husky](https://typicode.github.io/husky) è un modulo npm per la gestione degli hook.
Aggiungi la seguente riga alla configurazione pre-commit di husky nel tuo
`package.json`:```
talisman --githook pre-commit

Invocare direttamente talisman