Talisman

チェックインされる秘密情報を検出・防止するツール

目次

• Talismanとは？
• インストール
  • パスにインストール（推奨）
  • グローバルフックテンプレートとしてのインストール
• プロジェクトの設定
  • フックフレームワークとの併用
    • Pre-commit
    • Husky
  • Talismanを直接実行する
• アップグレード
• Talismanの動作
  • 検証
  • ファイルの無視
    • 対話モード
    • 特定の検出器を無視する
    • 特定のキーワードを無視する
    • 同じタイプの複数ファイルを無視する（ワイルドカード使用）
    • 言語スコープを指定してファイルを無視する
    • カスタム検索パターン
  • 重大度しきい値の設定
  • CLIユーティリティとしてのTalisman
    • 対話モード
    • Git履歴スキャナー
    • チェックサム計算機
• Talisman HTMLレポート
  • サンプルスクリーンショット
• アンインストール
  • グローバルフックテンプレートからのアンインストール
  • 単一リポジトリからのアンインストール
• Talismanへの貢献

Talismanとは？

Talismanとは、gitのチェンジセットをスキャンして、潜在的な秘密情報や機密情報が開発者のワークステーションから流出しないようにするツールです。

送信されるチェンジセットを検証し、疑わしいもの（SSHキー、認証トークン、秘密鍵など）を検出します。

インストール

TalismanはMAC OSX、Linux、Windowsをサポートしています。

Talismanは以下のいずれかの方法でインストールして使用できます。

1. スタンドアロン実行ファイルとして
2. グローバルなgitフックテンプレートとして、およびCLIユーティリティ（gitリポジトリスキャン用）としてのgitフック
3. 単一のgitリポジトリへのgitフックとして

Talismanは、gitリポジトリに対してpre-commitまたはpre-pushフックとして設定できます。

以下の手順に従ってください。

免責事項：強制プッシュによってgitリポジトリに紛れ込んだ秘密情報は、Talismanでは検出できません。強制プッシュはそれ自体が悪名高い行為と考えられており、リポジトリ管理者はそのような活動を許可するための適切な対策を講じることをお勧めします。

パスにインストール（推奨）

talismanをパスにインストールすることをお勧めします。これにより、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)"

または、Linuxではlinuxbrew、macOSではhomebrewを使用して、ターミナルで次のコマンドを実行してください：```bash
brew install talisman

Installation as a global hook template

We offer scripts that will install Talisman as a pre-commit git hook template, as that will cause Talisman to be present, not only in your existing git repositories, but also in any new repository that you 'init' or 'clone'.

1. Run the following command on your terminal, to download and install the binary at $HOME/.talisman/bin

As a pre-commit hook: ``` 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. $PATHにTALISMAN_HOMEが設定されていない場合は、適切な場所を設定するよう求められます。マシン上でプロファイルソースを設定したオプション番号を選択してください。 パスファイルでsourceを実行するか、端末を再起動することを忘れないでください。 後で$PATHを設定する場合は、export TALISMAN_HOME=$HOME/.talisman/binをパスに追加してください。

3. Talismanがすべてのgitリポジトリをスキャンするベースディレクトリを選択し、gitフック（ステップ1で選択したpre-commitまたはpre-push）をシンボリックリンクとして設定します。 このスクリプトは既存のフックを上書きしません。既存のフックがある場合は、フックフレームワークを使ってtalismanを追加できます。

• インストールを実行する前に、ベースディレクトリのパスをSEARCH_ROOT環境変数に設定しておくと、インストール中に手動で入力する必要がなくなります。

プロジェクトの設定

フックフレームワークの使用

フックとしてtalismanをグローバルにインストールしても、既存のフックは上書きされません。インストールスクリプトが既存のフックを検出した場合、コンソール上でその旨が示されるだけです。複数のフックを実行するには、pre-commitやhuskyなどのフックフレームワークを使用することをお勧めします。これらの手順では、talismanの実行ファイルがシステムのパス上のどこかにインストールされていることを前提としています。

Pre-commit

Talismanと一緒に既存のフックを管理するには、pre-commitを使用します。.pre-commit-config.yaml内で、pre-commit-hooksを参照してください：```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 モジュールです。
`package.json` 内の husky の pre-commit 設定に次の行を追加してください。```
talisman --githook pre-commit

talismanを直接呼び出す

talisman実行ファイルをインストールしたら、Gitリポジトリ用のスタンドアロンpre-commitフックを設定できます:```bash cd my-git-project echo "talisman -g pre-commit" >> .git/hooks/pre-commit chmod +x .git/hooks/pre-commit

# アップグレード
リリースv0.4.4以降、Talismanは<b>自動的に</b>フックが呼び出されたとき（プリコミット/プリプッシュ時、セットアップに応じて）バイナリを最新リリースに更新します。そのため、何もせずにリラックスして、追加の手間をかけずに最新のTalismanを使い続けられます。

以下の環境変数を設定できます：

1. TALISMAN_SKIP_UPGRADE: 自動アップグレードチェックをスキップしたい場合はtrueに設定します。デフォルトはfalseです。
2. TALISMAN_UPGRADE_CONNECT_TIMEOUT: アップグレードがキャンセルされるまでの最大接続タイムアウト（秒単位）。デフォルトは10秒です。

万が一、手動でアップグレードする必要がある場合、手順は次のとおりです：
<br>[推奨] Talismanバイナリとフックスクリプトを最新リリースに更新します：```bash
curl --silent  https://raw.githubusercontent.com/thoughtworks/talisman/main/global_install_scripts/update_talisman.bash > /tmp/update_talisman.bash && /bin/bash /tmp/update_talisman.bash

実行してTalismanバイナリのみを更新する：```bash curl --silent https://raw.githubusercontent.com/thoughtworks/talisman/main/global_install_scripts/update_talisman.bash > /tmp/update_talisman.bash && /bin/bash /tmp/update_talisman.bash talisman-binary

# 動作中のTalisman