Talisman

Uma ferramenta para detectar e impedir que segredos sejam commitados

Índice

• O que é o Talisman?
• Instalação
  • Instalar no PATH (abordagem recomendada)
  • Instalação como um modelo de hook global
• Configurando um projeto
  • Usando com frameworks de hook
    • Pre-commit
    • Husky
  • Invocando o talisman diretamente
• Atualização
• Talisman em ação
  • Validações
  • Ignorando arquivos
    • Modo interativo
    • Ignorando detectores específicos
    • Ignorando palavras-chave específicas
    • Ignorando múltiplos arquivos do mesmo tipo (com curingas)
    • Ignorando arquivos especificando o escopo da linguagem
    • Padrões de pesquisa personalizados
  • Configurando o limite de severidade
  • Talisman como utilitário de linha de comando
    • Modo interativo
    • Scanner de histórico do Git
    • Calculadora de checksum
• Relatório HTML do Talisman
  • Capturas de tela de exemplo
• Desinstalação
  • Desinstalação de um modelo de hook global
  • Desinstalação de um único repositório
• Contribuindo com o Talisman

O que é o Talisman?

O Talisman é uma ferramenta que examina os conjuntos de alterações do git para garantir que segredos potenciais ou informações sensíveis não saiam da estação de trabalho do desenvolvedor.

Ele valida o conjunto de alterações de saída em busca de coisas suspeitas – como chaves SSH em potencial, tokens de autorização, chaves privadas etc.

Instalação

O Talisman é compatível com MAC OSX, Linux e Windows.

O Talisman pode ser instalado e usado de uma das seguintes maneiras:

1. Como um executável autônomo
2. Como um hook git como um modelo de hook git global e um utilitário de linha de comando (para escanear repositórios git)
3. Como um hook git em um único repositório git

O Talisman pode ser configurado como um hook de pré-commit ou pré-push nos repositórios git.

Encontre as instruções abaixo.

Isenção de responsabilidade: Segredos que entram por meio de um push forçado em um repositório git não podem ser detectados pelo Talisman. Acredita-se que um push forçado seja notório por seus próprios problemas, e sugerimos que os administradores de repositórios git apliquem medidas apropriadas para autorizar tais atividades.

Instalar no PATH (abordagem recomendada)

Recomendamos instalar o talisman no seu PATH para que ele fique disponível para frameworks de hook git e scripts. Escolha o binário correto para o seu sistema na nossa Página de Releases, ou execute o nosso script de instalação:```bash bash -c "$(curl --silent https://raw.githubusercontent.com/thoughtworks/talisman/main/install.sh)"

Ou defina a variável de ambiente `INSTALL_LOCATION` para especificar um local personalizado para o binário:```bash
INSTALL_LOCATION=/usr/local/bin bash -c "$(curl --silent https://raw.githubusercontent.com/thoughtworks/talisman/main/install.sh)"

Ou defina a variável de ambiente VERSION para uma tag de lançamento para instalar uma versão específica::```bash VERSION=v1.36.0 bash -c "$(curl --silent https://raw.githubusercontent.com/thoughtworks/talisman/main/install.sh)"

Ou usando linuxbrew no Linux e homebrew no macOS executando o seguinte comando no terminal:```bash
brew install talisman

Instalação como um modelo de hook global

Oferecemos scripts que instalarão o Talisman como um modelo de hook git pre-commit, pois isso fará com que o Talisman esteja presente, não apenas nos seus repositórios git existentes, mas também em qualquer novo repositório que você 'init' ou 'clone'.

1. Execute o seguinte comando no seu terminal, para baixar e instalar o binário em $HOME/.talisman/bin

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

OU

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

2. Se você não tiver TALISMAN_HOME configurado no seu $PATH, será perguntado um local apropriado para configurá-lo. Escolha o número da opção onde você define a origem do perfil na sua máquina.

Lembre-se de executar source no arquivo de caminho ou reiniciar seu terminal. Se você optar por configurar o $PATH mais tarde, exporte TALISMAN_HOME=$HOME/.talisman/bin para o caminho.

3. Escolha um diretório base onde o Talisman deve procurar por todos os repositórios git e configure um gancho git (pre-commit ou pre-push, conforme escolhido no passo 1) como um link simbólico. Este script não substituirá ganchos pré-existentes. Se você tiver ganchos existentes, pode adicionar talisman através de um framework de ganchos

• você pode definir a variável de ambiente SEARCH_ROOT com o caminho do diretório base antes de executar a instalação para não precisar inseri-lo manualmente durante a instalação

Configurando um projeto

Usando com frameworks de ganchos

Instalar talisman globalmente como um gancho não substituirá nenhum gancho existente. Se o script de instalação encontrar ganchos existentes, ele apenas indicará isso no console. Para executar vários ganchos, sugerimos usar um framework de ganchos, como pre-commit ou husky. Estas instruções assumem que o executável talisman está instalado em algum lugar no caminho do seu sistema.

Pre-commit

Use pre-commit para gerenciar ganchos existentes junto com Talisman. Referencie nosso pre-commit-hooks no seu .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