Talisman

Una herramienta para detectar y prevenir que se introduzcan secretos en el repositorio

Tabla de Contenidos

• ¿Qué es Talisman?
• Instalación
  • Instalar en el PATH (enfoque recomendado)
  • Instalación como plantilla de hook global
• Configuración de un proyecto
  • Uso con frameworks de hooks
    • Pre-commit
    • Husky
  • Invocar talisman directamente
• Actualización
• Talisman en acción
  • Validaciones
  • Ignorar archivos
    • Modo interactivo
    • Ignorar detectores específicos
    • Ignorar palabras clave específicas
    • Ignorar múltiples archivos del mismo tipo (con comodines)
    • Ignorar archivos especificando el ámbito del lenguaje
    • Patrones de búsqueda personalizados
  • Configurar el umbral de severidad
  • Talisman como utilidad CLI
    • Modo interactivo
    • Escáner de historial de Git
    • Calculador de suma de verificación
• Informes HTML de Talisman
  • Capturas de pantalla de ejemplo
• Desinstalación
  • Desinstalación desde una plantilla de hook global
  • Desinstalación desde un solo repositorio
• Contribuir a Talisman

¿Qué es Talisman?

Talisman es una herramienta que escanea los conjuntos de cambios de git para asegurar que posibles secretos o información sensible no salgan de la estación de trabajo del desarrollador.

Valida el conjunto de cambios saliente en busca de elementos que parezcan sospechosos, como posibles claves SSH, tokens de autorización, claves privadas, etc.

Instalación

Talisman soporta macOS, Linux y Windows.

Talisman se puede instalar y utilizar de las siguientes maneras:

1. Como ejecutable independiente
2. Como un hook de git como una plantilla de hook de git global y una utilidad CLI (para escanear repositorios git)
3. Como un hook de git en un solo repositorio git

Talisman se puede configurar como un hook pre-commit o pre-push en los repositorios de git.

Encuentre las instrucciones a continuación.

Descargo de responsabilidad: Los secretos que se introduzcan mediante un forced push en un repositorio git no pueden ser detectados por Talisman. Se considera que un forced push es notoriamente problemático, y sugerimos a los administradores de repositorios git que tomen las medidas apropiadas para autorizar dichas actividades.

Instalar en el PATH (enfoque recomendado)

Recomendamos instalar talisman en su PATH para que esté disponible para frameworks de hooks de git y scripts. Elija el binario correcto para su sistema desde nuestra Página de lanzamientos, o ejecute nuestro script de instalación:```bash bash -c "$(curl --silent https://raw.githubusercontent.com/thoughtworks/talisman/main/install.sh)"

O establece la variable de entorno `INSTALL_LOCATION` para especificar una ubicación personalizada para
el binario:```bash
INSTALL_LOCATION=/usr/local/bin bash -c "$(curl --silent https://raw.githubusercontent.com/thoughtworks/talisman/main/install.sh)"

O establezca la variable de entorno VERSION a una etiqueta publicada para instalar una versión específica::```bash VERSION=v1.36.0 bash -c "$(curl --silent https://raw.githubusercontent.com/thoughtworks/talisman/main/install.sh)"

O usando linuxbrew en Linux y homebrew en macOS ejecutando el siguiente comando en la terminal:```bash
brew install talisman

Instalación como plantilla de hook global

Ofrecemos scripts que instalarán Talisman como una plantilla de hook pre-commit de git, ya que eso hará que Talisman esté presente, no solo en tus repositorios git existentes, sino también en cualquier nuevo repositorio que 'init' o 'clone'.

1. Ejecuta el siguiente comando en tu terminal, para descargar e instalar el binario en $HOME/.talisman/bin

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

O

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

2. Si no tienes TALISMAN_HOME configurado en tu $PATH, se te preguntará un lugar apropiado para configurarlo. Elige el número de opción donde estableces la fuente del perfil en tu máquina.

Recuerda ejecutar source en el archivo de ruta o reiniciar tu terminal. Si eliges configurar el $PATH más tarde, exporta TALISMAN_HOME=$HOME/.talisman/bin a la ruta.

3. Elige un directorio base donde Talisman deba escanear todos los repositorios git, y configura un hook de git (pre-commit o pre-push, como se eligió en el paso 1) como un enlace simbólico. Este script no sobrescribirá hooks preexistentes. Si tienes hooks existentes, puedes agregar talisman a través de un marco de hooks

• puedes configurar la variable de entorno SEARCH_ROOT con la ruta del directorio base antes de ejecutar la instalación para no tener que ingresarla manualmente durante la instalación

Configuring a project

Usando con marcos de hooks

Instalar globalmente talisman como un hook no sobrescribirá ningún hook existente. Si el script de instalación encuentra hooks existentes, solo lo indicará en la consola. Para ejecutar múltiples hooks, sugerimos usar un marco de hooks, como pre-commit o husky. Estas instrucciones asumen que el ejecutable de talisman está instalado en algún lugar del path de tu sistema.

Pre-commit

Usa pre-commit para gestionar hooks existentes junto con Talisman. Referencia nuestro pre-commit-hooks en tu .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) es un módulo npm para gestionar hooks.
Añade la siguiente línea a la configuración de pre-commit de husky en tu
`package.json`:```
talisman --githook pre-commit

Invocar talisman directamente