漏洩した認証情報を発見、検証、分析する
<p align="center">
<img alt="GoReleaser Logo" src="https://assets.kitploit.com/production/public/readmes/3815/31dbdb577b88b3a967e2c18f9b0f3d4a7031dafe7e392c51320178aba6352603.png" height="140" />
<h2 align="center">TruffleHog</h2>
<p align="center">漏洩した認証情報を検出します。</p>
</p>
---
<div align="center">
[](https://goreportcard.com/report/github.com/trufflesecurity/trufflehog/v3)
[](/LICENSE)
[](/pkg/detectors)
</div>
---
# :mag_right: _スキャン対象_
<div align="center">
<img src="https://raw.githubusercontent.com/trufflesecurity/trufflehog/HEAD/assets/scanning_logos.svg">
**...その他多数**
TruffleHog とその機能・能力について詳しく知るには、[製品ページ](https://trufflesecurity.com/trufflehog?gclid=CjwKCAjwouexBhAuEiwAtW_Zx5IW87JNj97Ci7heFnA5ar6-DuNzT2Y5nIl9DuZ-FOUqx0Qg3vb9nxoClcEQAvD_BwE)をご覧ください。
</div>
# :globe_with_meridians: TruffleHog Enterprise
**Git、Jira、Slack、Confluence、Microsoft Teams、Sharepoint(など)** を継続的に監視して認証情報を探すことにご興味はありませんか?それを支援できるエンタープライズ製品をご用意しています!詳しくは <https://trufflesecurity.com/trufflehog-enterprise> をご覧ください。
エンタープライズ製品からの収益は、コミュニティ全体が恩恵を受けられる、より優れたオープンソースプロジェクトの資金に充てています。
</div>
# TruffleHog とは 🐽
TruffleHog は、最も強力なシークレットの **発見、分類、検証、分析** ツールです。ここでいうシークレットとは、マシンが別のマシンに対して自身を認証するために使用する認証情報を指します。これには API キー、データベースのパスワード、秘密暗号鍵などが含まれます。
## 発見 🔍
TruffleHog は、Git、チャット、Wiki、ログ、API テストプラットフォーム、オブジェクトストレージ、ファイルシステムなど、さまざまな場所でシークレットを探すことができます。
## 分類 📁
TruffleHog は 800 種類以上のシークレットを分類し、それらが属する特定の識別情報にマッピングします。AWS のシークレットか?Stripe のシークレットか?Cloudflare のシークレットか?Postgres のパスワードか?SSL 秘密鍵か?見ただけでは判別が難しいこともあるため、TruffleHog は検出したすべてを分類します。
## 検証 ✅
TruffleHog は分類できるすべてのシークレットについて、ログインしてそのシークレットが有効かどうかを確認することもできます。このステップは、現在アクティブな危険が存在するかどうかを知るうえで極めて重要です。
## 分析 🔬
最もよく漏洩する 20 種類ほどの認証情報タイプについては、シークレットがログインできるかどうかを確認するために 1 つのリクエストを送る代わりに、TruffleHog は多数のリクエストを送信して、そのシークレットに関するあらゆる情報を調べることができます。誰が作成したのか?どのリソースにアクセスできるのか?それらのリソースに対してどのような権限を持っているのか?
# :loudspeaker: コミュニティに参加しましょう
質問はありますか?フィードバックはありますか?Slack または Discord に参加して、私たちと交流しましょう。
[Slack コミュニティ](https://join.slack.com/t/trufflehog-community/shared_invite/zt-pw2qbi43-Aa86hkiimstfdKH9UCpPzQ)に参加する
[Secret Scanning Discord](https://discord.gg/8Hzbrnkr7E)に参加する
# :tv: デモ

```bash
docker run --rm -it -v "$PWD:/pwd" trufflesecurity/trufflehog:latest github --org=trufflesecurity
```
# :floppy_disk: インストール
いくつかのオプションが用意されています:
### MacOS ユーザー
```bash
brew install trufflehog
```
### Docker:
<sub><i>_以下のコマンドを実行する前に、Docker エンジンが起動していることを確認してください:_</i></sub>
#### Unix
```bash
docker run --rm -it -v "$PWD:/pwd" trufflesecurity/trufflehog:latest github --repo https://github.com/trufflesecurity/test_keys
```
#### Windows コマンドプロンプト
```bash
docker run --rm -it -v "%cd:/=\%:/pwd" trufflesecurity/trufflehog:latest github --repo https://github.com/trufflesecurity/test_keys
```
#### Windows PowerShell
```bash
docker run --rm -it -v "${PWD}:/pwd" trufflesecurity/trufflehog github --repo https://github.com/trufflesecurity/test_keys
```
#### M1 および M2 Mac
```bash
docker run --platform linux/arm64 --rm -it -v "$PWD:/pwd" trufflesecurity/trufflehog:latest github --repo https://github.com/trufflesecurity/test_keys
```
### バイナリリリース
```bash
Download and unpack from https://github.com/trufflesecurity/trufflehog/releases
```
### ソースからコンパイルする
```bash
git clone https://github.com/trufflesecurity/trufflehog.git
cd trufflehog; go install
```
### インストールスクリプトの使用
```bash
curl -sSfL https://raw.githubusercontent.com/trufflesecurity/trufflehog/main/scripts/install.sh | sh -s -- -b /usr/local/bin
```
### インストールスクリプトを使用し、チェックサム署名を検証する(cosign がインストールされている必要があります)
```bash
curl -sSfL https://raw.githubusercontent.com/trufflesecurity/trufflehog/main/scripts/install.sh | sh -s -- -v -b /usr/local/bin
```
### インストールスクリプトを使用して特定のバージョンをインストールする
```bash
curl -sSfL https://raw.githubusercontent.com/trufflesecurity/trufflehog/main/scripts/install.sh | sh -s -- -b /usr/local/bin <ReleaseTag like v3.56.0>
```
# :closed_lock_with_key: アーティファクトの検証
すべてのアーティファクトにチェックサムが適用され、生成されたチェックサムファイルはcosignを使用して署名されます。
署名を検証するには、以下のツールが必要です:
- [Cosign](https://docs.sigstore.dev/cosign/system_config/installation/)
検証手順は以下のとおりです:
1. 必要なアーティファクトファイルと、[releases](https://github.com/trufflesecurity/trufflehog/releases)ページから以下のファイルをダウンロードします。
- trufflehog\_{version}\_checksums.txt
- trufflehog\_{version}\_checksums.txt.pem
- trufflehog\_{version}\_checksums.txt.sig
2. 署名を検証します:
```shell
cosign verify-blob <path to trufflehog_{version}_checksums.txt> \
--certificate <path to trufflehog_{version}_checksums.txt.pem> \
--signature <path to trufflehog_{version}_checksums.txt.sig> \
--certificate-identity-regexp 'https://github\.com/trufflesecurity/trufflehog/\.github/workflows/.+' \
--certificate-oidc-issuer "https://token.actions.githubusercontent.com"
```
3. 署名が有効であることが確認されたら、SHA256 サムがダウンロードした成果物と一致することを検証できます:
```shell
sha256sum --ignore-missing -c trufflehog_{version}_checksums.txt
```
`{version}` をダウンロードしたファイルのバージョンに置き換えてください。
あるいは、インストールスクリプトを使用している場合は、`-v` オプションを渡して署名検証を実行してください。
これには、インストールスクリプトを実行する前に Cosign バイナリがインストールされている必要があります。
# :rocket: クイックスタート
## 1: 検証済みのシークレットのみを対象にリポジトリをスキャンする
コマンド:
```bash
trufflehog git https://github.com/trufflesecurity/test_keys --results=verified
```
予想される出力:
```
🐷🔑🐷 TruffleHog. Unearth your secrets. 🐷🔑🐷
Found verified result 🐷🔑
Detector Type: AWS
Decoder Type: PLAIN
Raw result: AKIAYVP4CIPPERUVIFXG
Line: 4
Commit: fbc14303ffbf8fb1c2c1914e8dda7d0121633aca
File: keys
Email: counter <[email protected]>
Repository: https://github.com/trufflesecurity/test_keys
Timestamp: 2022-06-16 10:17:40 -0700 PDT
...
```
## 2: GitHub Org をスキャンして検証済みのシークレットのみを検出する
```bash
trufflehog github --org=trufflesecurity --results=verified
```
## 3: アーカイブ済みリポジトリを除外して GitHub Org をスキャンする
```bash
trufflehog github --org=trufflesecurity --exclude-archived
```
## 4: GitHubリポジトリをスキャンして検証済みのシークレットのみを取得し、JSON出力を得る
コマンド:
```bash
trufflehog git https://github.com/trufflesecurity/test_keys --results=verified --json
```
予想される出力:
```
{"SourceMetadata":{"Data":{"Git":{"commit":"fbc14303ffbf8fb1c2c1914e8dda7d0121633aca","file":"keys","email":"counter \[email protected]\u003e","repository":"https://github.com/trufflesecurity/test_keys","timestamp":"2022-06-16 10:17:40 -0700 PDT","line":4}}},"SourceID":0,"SourceType":16,"SourceName":"trufflehog - git","DetectorType":2,"DetectorName":"AWS","DecoderName":"PLAIN","Verified":true,"Raw":"AKIAYVP4CIPPERUVIFXG","Redacted":"AKIAYVP4CIPPERUVIFXG","ExtraData":{"account":"595918472158","arn":"arn:aws:iam::595918472158:user/canarytokens.com@@mirux23ppyky6hx3l6vclmhnj","user_id":"AIDAYVP4CIPPJ5M54LRCY"},"StructuredData":null}
...
```
TruffleHogは`--json`の代わりに`--sarif`を指定することで[SARIF](https://docs.oasis-open.org/sarif/sarif/v2.1.0/sarif-v2.1.0.html)を出力することもできます。GitHub code scanningはSARIFをネイティブに理解するため、アップロードするとプルリクエストの差分やリポジトリのSecurityタブに検出結果がインラインで表示され、実行のたびに同じ検出結果を報告するのではなく、スキャン間で新規/修正済みとして検出結果を追跡できます。アップロード方法については、後述の[TruffleHog Github Action](#octocat-trufflehog-github-action)セクションを参照してください。なお、他の出力形式とは異なり、SARIFの結果はスキャン全体を通じてメモリにバッファリングされ、最後にまとめて書き出されます。これはSARIFがストリームではなく単一のJSONドキュメントを必要とするためです。通常のスキャンでは問題ありませんが、非常に多くの結果を生成するスキャンでは、それに比例して多くのメモリを使用します。
## 5: GitHubリポジトリとそのIssueおよびPull Requestをスキャンする
```bash
trufflehog github --repo=https://github.com/trufflesecurity/test_keys --issue-comments --pr-comments
```
## 6: 高信頼度の結果(検証済み + 不明)を得るために S3 バケットをスキャンする
```bash
trufflehog s3 --bucket=<bucket name> --results=verified,unknown
```
## 7: IAM ロールを使用して S3 バケットをスキャンする
```bash
trufflehog s3 --role-arn=<iam role arn>
```
## 8: Docker 内で SSH 認証を使用して GitHub リポジトリをスキャンする
```bash
docker run --rm -v "$HOME/.ssh:/root/.ssh:ro" trufflesecurity/trufflehog:latest git ssh://github.com/trufflesecurity/test_keys
```
## 9: 個々のファイルまたはディレクトリをスキャンする
```bash
trufflehog filesystem path/to/file1.txt path/to/file2.txt path/to/dir
```
## 10: ローカル git リポジトリをスキャンする
git リポジトリをクローンします。例えば [test keys](https://github.com/trufflesecurity/trufflehog/blob/main/git%40github.com%3Atrufflesecurity/test_keys.git) リポジトリです。
```bash
git clone [email protected]:trufflesecurity/test_keys.git
```
親ディレクトリ(git リポジトリの外)から trufflehog を実行します。
```bash
trufflehog git file://test_keys --results=verified,unknown
```
ローカルスキャン時の悪意ある git config から保護するため(CVE-2025-41390 を参照)、TruffleHog はスキャン前にローカル git リポジトリを一時ディレクトリにクローンします。これは [Git のセキュリティベストプラクティス](https://git-scm.com/docs/git#_security) に従ったものです。リポジトリのクローン先を(tmp ではなく)カスタムパスに指定したい場合は、`--clone-path` フラグを使用できます。ローカルクローン処理をスキップしてリポジトリを直接スキャンしたい場合(信頼できるリポジトリに対してのみ行ってください)は、`--trust-local-git-config` フラグを使用できます。
## 11: 検証済みのシークレットのみを対象に GCS バケットをスキャンする
```bash
trufflehog gcs --project-id=<project-ID> --cloud-environment --results=verified
```
## 12: 検証済みのシークレットのみを対象に Docker イメージをスキャンする
複数のイメージをスキャンするには、`--image` フラグを複数回使用します。
```bash
# to scan from a remote registry
trufflehog docker --image trufflesecurity/secrets --results=verified
# to scan from the local docker daemon
trufflehog docker --image docker://new_image:tag --results=verified
# to scan from an image saved as a tarball
trufflehog docker --image file://path_to_image.tar --results=verified
```
## 13: CI でのスキャン
`--since-commit` フラグには、マージ先となるデフォルトブランチ(例: "main")を設定します。`--branch` フラグには、PR のブランチ名(例: "feature-1")を設定します。使用する CI/CD プラットフォームによっては、この値を動的に取得できます(例: [Circle CI の CIRCLE_BRANCH](https://circleci.com/docs/variables/) や [Travis CI の TRAVIS_PULL_REQUEST_BRANCH](https://docs.travis-ci.com/user/environment-variables/))。CI/CD ワークフロー中にリポジトリがクローンされ、対象ブランチがすでにチェックアウトされている場合は、`--branch HEAD` で十分です。`--fail` フラグを指定すると、有効な認証情報が見つかった場合に 183 エラーコードを返します。
```bash
trufflehog git file://. --since-commit main --branch feature-1 --results=verified,unknown --fail
```
## 14: Postman ワークスペースをスキャンする
複数のターゲットをスキャンするには、`--workspace-id`、`--collection-id`、`--environment` フラグを複数回使用します。
```bash
trufflehog postman --token=<postman api token> --workspace-id=<workspace id>
```
## 15: Jenkinsサーバーをスキャンする
```bash
trufflehog jenkins --url https://jenkins.example.com --username admin --password admin
```
## 16: Elasticsearch サーバーをスキャンする
### ローカルクラスタをスキャンする
TruffleHog でローカルクラスタに認証する方法は 2 つあります: (1) ユーザー名とパスワード、(2) サービストークンです。
#### ユーザー名とパスワードでローカルクラスタに接続する
```bash
trufflehog elasticsearch --nodes 192.168.14.3 192.168.14.4 --username truffle --password hog
```
#### サービス トークンを使用してローカル クラスタに接続する
```bash
trufflehog elasticsearch --nodes 192.168.14.3 192.168.14.4 --service-token ‘AAEWVaWM...Rva2VuaSDZ’
```
### Elastic Cloud クラスタをスキャンする
Elastic Cloud 上のクラスタをスキャンするには、Cloud ID と API キーが必要です。
```bash
trufflehog elasticsearch \
--cloud-id 'search-prod:dXMtY2Vx...YjM1ODNlOWFiZGRlNjI0NA==' \
--api-key 'MlVtVjBZ...ZSYlduYnF1djh3NG5FQQ=='
```
## 17. GitHubリポジトリのクロスフォークオブジェクト参照と削除されたコミットをスキャンする
次のコマンドは、GitHubリポジトリ上の削除されたコミットおよび隠されたコミットを列挙し、それらをシークレットについてスキャンします。これはアルファリリースの機能です。
```bash
trufflehog github-experimental --repo https://github.com/<USER>/<REPO>.git --object-discovery
```
通常のTruffleHog出力に加えて、`--object-discovery`フラグを指定すると、新しい`$HOME/.trufflehog`ディレクトリに`valid_hidden.txt`と`invalid.txt`の2つのファイルが作成されます。これらはコミット列挙中の状態を追跡するために使用され、また、すべての非表示および削除されたコミットの完全なリスト(`valid_hidden.txt`)をユーザーに提供するためにも使用されます。スキャン後にこれらのファイルを自動的に削除したい場合は、`--delete-cached-data`フラグを追加してください。
**注**: この方法を使用してリポジトリ上のすべての有効なコミットを列挙するには、リポジトリのサイズに応じて20分から数時間かかります。列挙にかかる時間を把握できるよう、プログレスバーを追加しました。実際のシークレットスキャンは非常に高速に実行されます。
Cross Fork Object Referencesの詳細については、[ブログ記事をお読みください](https://trufflesecurity.com/blog/anyone-can-access-deleted-and-private-repo-data-github)。
## 18. Hugging Faceのスキャン
### Hugging Faceのモデル、データセット、スペース、またはバケットのスキャン
```bash
trufflehog huggingface \
--model <model_id> \
--dataset <dataset_id> \
--space <space_id> \
--bucket <bucket_id>
```
### Hugging Face の組織またはユーザーに属するすべてのモデル、データセット、スペース、バケットをスキャンする
```bash
trufflehog huggingface --org <orgname> --user <username>
```
(任意)組織またはユーザーをスキャンする際、`--skip-all-models`、`--skip-all-datasets`、`--skip-all-spaces`、`--skip-all-buckets` でリソースのクラス全体をスキップするか、`--ignore-models <model_id>`、`--ignore-datasets <dataset_id>`、`--ignore-spaces <space_id>`、`--ignore-buckets <bucket_id>` で特定のリソースをスキップできます。
### Discussion と PR コメントのスキャン
```bash
trufflehog huggingface --model <model_id> --include-discussions --include-prs
```
## 19. stdin 入力をスキャンする
```bash
aws s3 cp s3://example/gzipped/data.gz - | gunzip -c | trufflehog stdin
```
# :question: FAQ
- `🐷🔑🐷 TruffleHog. Unearth your secrets. 🐷🔑🐷` とだけ表示されてプログラムが終了するのはなぜですか?
- それはシークレットが検出されなかったことを意味します
- GitHub org をスキャンするときにスキャンに時間がかかるのはなぜですか
- 認証なしの GitHub スキャンにはレート制限があります。レート制限を改善するには、パーソナルアクセストークンを指定して `--token` フラグを含めてください
- 秘密鍵が検証されたと表示されますが、どういう意味ですか?
- 検証済みの結果とは、TruffleHog がその認証情報をサービスの API に対してテストし、有効であることを確認したことを意味します。秘密鍵については、その鍵が SSH または SSL 認証に実際に使用できることを確認しています。詳細は Driftwood のブログ記事をご覧ください [ブログ記事](https://trufflesecurity.com/blog/driftwood-know-if-private-keys-are-sensitive/)
- 特定のシークレットを簡単に無視する方法はありますか?
- スキャン対象のソースが[行番号をサポートしている](https://github.com/trufflesecurity/trufflehog/blob/d6375ba92172fd830abb4247cca15e3176448c5d/pkg/engine/engine.go#L358-L365)場合、シークレットを含む行に `trufflehog:ignore` コメントを追加することで、そのシークレットを無視できます。
- `trufflehog:ignore` が含まれているシークレットを見つけることはできますか?
- `--no-ignore-tag` を渡すと、行に `trufflehog:ignore` コメントが付いている場合でも結果を報告します。これは、以前に受け入れた検出結果をレビューするのに便利です。
# :newspaper: v3 の新機能は?
TruffleHog v3 は Go で完全に書き直され、多くの新しい強力な機能を備えています。
- **それぞれの API に対してアクティブ検証をサポートする 700 以上の認証情報検出器を追加しました**。
- **GitHub、GitLab、Docker、ファイルシステム、S3、GCS、Circle CI、Travis CI のスキャンをネイティブにサポート**しました。
- 当社の [Driftwood](https://trufflesecurity.com/blog/driftwood) 技術を使用して、数百万の GitHub ユーザーと **数十億** の TLS 証明書に対して**秘密鍵を即座に検証**します。
- バイナリ、ドキュメント、その他のファイル形式をスキャン
- GitHub Action および pre-commit フックとして利用可能
## 認証情報の検証とは?
検出されたすべての潜在的な認証情報について、それが属すると考えられる API に対してプログラムによる検証を丹念に実装しています。検証により誤検知が排除され、3 つの結果ステータスが提供されます:
- **verified**: API テストにより認証情報が有効かつアクティブであることが確認された
- **unverified**: 認証情報は検出されたが、有効であることは確認されていない(無効、期限切れ、または検証が無効になっている可能性がある)
- **unknown**: 検証を試みたが、ネットワークや API の障害などのエラーにより失敗した
例えば、[AWS 認証情報検出器](https://github.com/trufflesecurity/trufflehog/blob/main/pkg/detectors/aws/access_keys/accesskey.go)は、AWS 認証情報がアクティブかどうかを検証するために、AWS API に対して `GetCallerIdentity` API 呼び出しを実行します。
# :memo: 使用方法
TruffleHog には、スキャンしたいデータソースごとにサブコマンドがあります:
- git
- github
- gitlab
- huggingface
- docker
- s3
- filesystem (ファイルとディレクトリ)
- syslog
- circleci
- travisci
- gcs (Google Cloud Storage)
- postman
- jenkins
- elasticsearch
- stdin
- multi-scan
各サブコマンドにはオプションがあり、サブコマンドに指定する `--help` フラグで確認できます:
```
$ trufflehog git --help
usage: TruffleHog [<flags>] <command> [<args> ...]
TruffleHog is a tool for finding credentials.
Flags:
-h, --[no-]help Show context-sensitive help (also try --help-long and --help-man).
--log-level=0 Logging verbosity on a scale of 0 (info) to 5 (trace). Can be
disabled with "-1".
--[no-]profile Enables profiling and sets a pprof and fgprof server on :18066.
-j, --[no-]json Output in JSON format.
--[no-]json-legacy Use the pre-v3.0 JSON format. Only works with git, gitlab,
and github sources.
--[no-]github-actions Output in GitHub Actions format.
--[no-]sarif Output in SARIF format for upload to GitHub code scanning (e.g.
via github/codeql-action/upload-sarif).
--concurrency=12 Number of concurrent workers.
--[no-]no-verification Don't verify the results.
--results=RESULTS Specifies which type(s) of results to output: verified (confirmed
valid by API), unknown (verification failed due to error),
unverified (detected but not verified), filtered_unverified
(unverified but would have been filtered out). Defaults to
verified,unverified,unknown.
--[no-]no-color Disable colorized output
--[no-]allow-verification-overlap
Allow verification of similar credentials across detectors
--[no-]filter-unverified Only output first unverified result per chunk per detector if there
are more than one results.
--filter-entropy=FILTER-ENTROPY
Filter unverified results with Shannon entropy. Start with 3.0.
--config=CONFIG Path to configuration file.
--[no-]print-avg-detector-time
Print the average time spent on each detector.
--[no-]no-update Don't check for updates.
--[no-]fail Exit with code 183 if results are found.
--[no-]fail-on-scan-errors
Exit with non-zero error code if an error occurs during the scan.
--verifier=VERIFIER ... Set custom verification endpoints.
--[no-]custom-verifiers-only
Only use custom verification endpoints.
--detector-timeout=DETECTOR-TIMEOUT
Maximum time to spend scanning chunks per detector (e.g., 30s).
--archive-max-size=ARCHIVE-MAX-SIZE
Maximum size of archive to scan. (Byte units eg. 512B, 2KB, 4MB)
--archive-max-depth=ARCHIVE-MAX-DEPTH
Maximum depth of archive to scan.
--archive-timeout=ARCHIVE-TIMEOUT
Maximum time to spend extracting an archive.
--include-detectors="all" Comma separated list of detector types to include. Protobuf name or
IDs may be used, as well as ranges.
--exclude-detectors=EXCLUDE-DETECTORS
Comma separated list of detector types to exclude. Protobuf name
or IDs may be used, as well as ranges. IDs defined here take
precedence over the include list.
--[no-]no-verification-cache
Disable verification caching
--[no-]force-skip-binaries
Force skipping binaries.
--[no-]force-skip-archives
Force skipping archives.
--[no-]skip-additional-refs
Skip additional references.
--user-agent-suffix=USER-AGENT-SUFFIX
Suffix to add to User-Agent.
--[no-]version Show application version.
Commands:
help [<command>...]
Show help.
git [<flags>] <uri>
Find credentials in git repositories.
github [<flags>]
Find credentials in GitHub repositories.
github-experimental --repo=REPO [<flags>]
Run an experimental GitHub scan. Must specify at least one experimental sub-module to run:
object-discovery.
gitlab --token=TOKEN [<flags>]
Find credentials in GitLab repositories.
filesystem [<flags>] [<path>...]
Find credentials in a filesystem.
s3 [<flags>]
Find credentials in S3 buckets.
gcs [<flags>]
Find credentials in GCS buckets.
syslog --format=FORMAT [<flags>]
Scan syslog
circleci --token=TOKEN
Scan CircleCI
docker [<flags>]
Scan Docker Image
travisci --token=TOKEN
Scan TravisCI
postman [<flags>]
Scan Postman
elasticsearch [<flags>]
Scan Elasticsearch
jenkins --url=URL [<flags>]
Scan Jenkins
huggingface [<flags>]
Find credentials in HuggingFace datasets, models, spaces and buckets.
stdin
Find credentials from stdin.
multi-scan
Find credentials in multiple sources defined in configuration.
json-enumerator [<path>...]
Find credentials from a JSON enumerator input.
analyze
Analyze API keys for fine-grained permissions information.
```
例えば、`git` リポジトリをスキャンするには、まず次を実行します
```
trufflehog git https://github.com/trufflesecurity/trufflehog.git
```
## 設定
TruffleHog は、`--config` フラグで指定する設定ファイル内で[カスタム正規表現検出器](#custom-regex-detector-alpha)と複数のソースを定義することをサポートしています。
正規表現検出器は任意のサブコマンドで使用できますが、設定で定義されたソースは `multi-scan` サブコマンド専用です。
ソースの設定形式については、Truffle Security の
[ソース設定ドキュメントページ](https://trufflesecurity.com/docs/connect-sources)を参照してください。
GitHub ソース設定の例と[オプションリファレンス](https://docs.trufflesecurity.com/github#Fvm1I):
```yaml
sources:
- connection:
'@type': type.googleapis.com/sources.GitHub
repositories:
- https://github.com/trufflesecurity/test_keys.git
unauthenticated: {}
name: example config scan
type: SOURCE_TYPE_GITHUB
verify: true
```
`sources` キーの下に複数の接続を定義できます(上記参照)。TruffleHog はすべてのソースを同時にスキャンします。
特定の1つのソースのみのデバッグログを確認するには、そのソースに `debug: true` を追加します。そのソースはすべてのデバッグログを書き出し、他のすべてのソースは通常のログレベルを維持します。これは、多数のソースのうち1つが誤動作している場合に便利です:
```yaml
sources:
- connection:
'@type': type.googleapis.com/sources.GitHub
repositories:
- https://github.com/trufflesecurity/test_keys.git
unauthenticated: {}
name: example config scan
type: SOURCE_TYPE_GITHUB
debug: true
```
すべてのソースでデバッグログを有効にするには、代わりに `--log-level=5` を使用してください。
## S3
S3 ソースは、IAM ユーザーに加えて、スキャンのために IAM ロールを引き受けることをサポートしています。これにより、ユーザーは各アカウントのハードコードされた認証情報に依存することなく、複数の AWS アカウントを簡単にスキャンできます。
TruffleHog が最初に使用する IAM アイデンティティは、引き受ける各 IAM ロールの[信頼ポリシー](https://aws.amazon.com/blogs/security/how-to-use-trust-policies-with-iam-roles/)において、プリンシパルとして `AssumeRole` 権限を持っている必要があります。
ローカルに設定された認証情報、または EC2 インスタンス上の場合はインスタンスメタデータを使用して、特定のバケットをスキャンするには:
```bash
trufflehog s3 --bucket=<bucket-name>
```
特定のバケットを引き受けたロールを使用してスキャンするには:
```bash
trufflehog s3 --bucket=<bucket-name> --role-arn=<iam-role-arn>
```
複数のロールを個別の引数として渡すことができます。次のコマンドは、各ロールが S3 API でリストする権限を持つすべてのバケットをスキャンしようとします:
```bash
trufflehog s3 --role-arn=<iam-role-arn-1> --role-arn=<iam-role-arn-2>
```
### スキャンを特定のオブジェクトに絞り込む
---
[Read more](https://github.com/trufflesecurity/trufflehog)