Talisman

Инструмент для обнаружения и предотвращения попадания секретов в репозиторий

Содержание

• Что такое Talisman?
• Установка
  • Установка в PATH (рекомендуемый способ)
  • Установка в качестве глобального шаблона хуков
• Настройка проекта
  • Использование с фреймворками хуков
    • Pre-commit
    • Husky
  • Прямой вызов talisman
• Обновление
• Talisman в действии
  • Проверки
  • Игнорирование файлов
    • Интерактивный режим
    • Игнорирование определённых детекторов
    • Игнорирование определённых ключевых слов
    • Игнорирование нескольких файлов одного типа (с помощью шаблонов)
    • Игнорирование файлов с указанием языковой области
    • Пользовательские шаблоны поиска
  • Настройка порога серьёзности
  • Talisman как утилита командной строки
    • Интерактивный режим
    • Сканер истории Git
    • Калькулятор контрольных сумм
• Создание HTML-отчётов Talisman
  • Примеры скриншотов
• Удаление
  • Удаление из глобального шаблона хуков
  • Удаление из одного репозитория
• Вклад в развитие Talisman

Что такое Talisman?

Talisman — это инструмент, который проверяет наборы изменений git, чтобы гарантировать, что потенциальные секреты или конфиденциальная информация не покидают рабочую станцию разработчика.

Он проверяет исходящие изменения на предмет подозрительного содержимого, такого как потенциальные SSH-ключи, токены авторизации, закрытые ключи и т.д.

Установка

Talisman поддерживает MAC OSX, Linux и Windows.

Talisman может быть установлен и использован одним из следующих способов:

1. Как отдельный исполняемый файл
2. Как хук git в качестве глобального шаблона хуков git и утилита командной строки (для сканирования git-репозиториев)
3. Как хук git в один репозиторий git

Talisman можно настроить как pre-commit или pre-push хук в git-репозиториях.

Инструкции приведены ниже.

Отказ от ответственности: Talisman не может обнаружить секреты, попадающие в git-репозиторий через принудительный push. Принудительный push считается вредоносным действием, и мы рекомендуем администраторам git-репозиториев применять соответствующие меры для авторизации таких действий.

Установка в PATH (рекомендуемый способ)

Мы рекомендуем установить talisman в PATH, чтобы он был доступен для фреймворков хуков git и скриптов. Выберите правильный двоичный файл для вашей системы на нашей странице релизов или запустите наш скрипт установки:```bash bash -c "$(curl --silent https://raw.githubusercontent.com/thoughtworks/talisman/main/install.sh)"

Или установите переменную окружения `INSTALL_LOCATION`, чтобы указать собственное расположение для бинарного файла:```bash
INSTALL_LOCATION=/usr/local/bin bash -c "$(curl --silent https://raw.githubusercontent.com/thoughtworks/talisman/main/install.sh)"

Или установите переменную окружения VERSION на тег релиза, чтобы установить конкретную версию::```bash VERSION=v1.36.0 bash -c "$(curl --silent https://raw.githubusercontent.com/thoughtworks/talisman/main/install.sh)"

Или используя linuxbrew в Linux и homebrew в macOS, выполнив следующую команду в терминале:```bash
brew install talisman

Установка в качестве глобального шаблона хука

Мы предлагаем скрипты, которые установят Talisman в качестве шаблона хука git pre-commit, так как это обеспечит присутствие Talisman не только в ваших существующих git-репозиториях, но и в любом новом репозитории, который вы инициализируете ('init') или клонируете ('clone').

1. Выполните следующую команду в терминале, чтобы загрузить и установить бинарный файл в $HOME/.talisman/bin

В качестве хука pre-commit: ``` bash -c "$(curl --silent https://raw.githubusercontent.com/thoughtworks/talisman/main/global_install_scripts/install.bash)"

ИЛИ

  В качестве pre-push hook:  ```
bash -c "$(curl --silent https://raw.githubusercontent.com/thoughtworks/talisman/main/global_install_scripts/install.bash)" -- pre-push

2. Если у вас не задана TALISMAN_HOME в вашем $PATH, вас попросят указать подходящее место для её настройки. Выберите номер опции, где вы указываете источник профиля на вашей машине.

Помните, что нужно выполнить source для файла пути или перезапустить терминал. Если вы решите настроить $PATH позже, экспортируйте TALISMAN_HOME=$HOME/.talisman/bin в путь.

3. Выберите базовую директорию, в которой Talisman будет сканировать все git-репозитории, и установите git-хук (pre-commit или pre-push, как выбрано на шаге 1) в виде симлинка. Этот скрипт не перезапишет существующие хуки. Если у вас есть существующие хуки, вы можете добавить talisman через фреймворк хуков

• вы можете установить переменную окружения SEARCH_ROOT с путём к базовой директории перед выполнением установки, чтобы не вводить его вручную во время установки

Configuring a project

Using with hook frameworks

Глобальная установка talisman в качестве хука не перезапишет существующие хуки. Если скрипт установки обнаружит существующие хуки, он только сообщит об этом в консоли. Для запуска нескольких хуков мы рекомендуем использовать фреймворк хуков, такой как pre-commit или husky. Эти инструкции предполагают, что исполняемый файл talisman установлен где-то в вашем системном пути.

Pre-commit

Используйте pre-commit для управления существующими хуками вместе с Talisman. Ссылайтесь на наш pre-commit-hooks в вашем .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) — это npm-модуль для управления хуками.
Добавьте следующую строку в конфигурацию pre-commit husky в вашем
`package.json`:```
talisman --githook pre-commit

Прямой запуск talisman