ソースコードおよびgit履歴を対象とした、依存関係のない小さなシークレットスキャナーで、そのまま使えるGitLab CIジョブを備えています。
本番環境に到達する前に、漏洩したAPIキー、トークン、秘密鍵、パスワードを検出します。これには、一度コミットされて後から「削除」されたものの、依然として履歴に残っているシークレットも含まれます。
$ secretscan scan . --history
[HIGH ] url-credentials deploy.sh:1 (commit 79831acaf3, Dev <[email protected]>)
Credentials embedded in a URL: Fake********
[HIGH ] aws-access-key-id settings.py:1 (commit 79831acaf3, Dev <[email protected]>)
AWS access key ID: AKIA************
2 potential secret(s) found.
そのデモでは、AWSキーは後のコミットでsettings.pyから削除されました。単純なファイルスキャンではリポジトリはクリーンと判定されますが、キーはgit log -pで依然として復元可能であるため、漏洩したままです。
password = "..."ルール。changeme、${API_KEY}、{{ vault_token }}、<your-password>などの値に対するプレースホルダーフィルターも適用。--rev-range base..HEADで新しいコミットのみをスキャンします。.secretscanignore(gitignore形式のglob)およびインラインの# secretscan:ignore。--fail-on重大度しきい値。pip install git+https://gitlab.com/DaveyD347/secrets-scanner.git
# or, from a clone
pip install -e ".[dev]"
secretscan scan # scan the current directory's files
secretscan scan path/to/repo --history # files + entire git history
secretscan scan . --history-only # history only
secretscan scan . --rev-range origin/main..HEAD # only commits not yet on main
secretscan scan . --format json -o findings.json
secretscan scan . --fail-on high # only fail on high/critical
secretscan rules # list rules
| 終了コード | 意味 |
|---|---|
| 0 | --fail-on 以上の検出結果なし |
| 1 | --fail-on 以上の検出結果あり |
| 2 | 使用エラー(不正なパス、git リポジトリでない、など) |
インラインマーカーを追加します:
EXAMPLE_KEY = "..." # secretscan:ignore
Or create .secretscanignore at the repo root:
# test fixtures
tests/fixtures/
*.lock
再利用可能なジョブを任意のプロジェクトに追加します:
include:
- remote: "https://gitlab.com/DaveyD347/secrets-scanner/-/raw/main/templates/secretscan.gitlab-ci.yml"
ジョブは完全な履歴をクローンし(GIT_DEPTH: 0)、マージリクエストパイプラインでは新しいコミットのみをスキャンし、それ以外では
履歴全体をスキャンします。検出結果があればパイプラインを失敗させ、gl-secret-detection-report.json を
secret_detection レポートとしてアップロードします。GitLab Ultimate ではこれらの検出結果がマージリクエストのセキュリティウィジェットと
脆弱性レポートに表示されます。それ以外のティアでも、レポートはダウンロード可能なアーティファクトとして保持されます。しきい値を調整するには
SECRETSCAN_FAIL_ON を設定してください。
このリポジトリ自身の .gitlab-ci.yml は、リント、Python 3.10 から 3.13 でのカバレッジ付きテスト、
およびスキャナを自身の履歴に対して実行します。
src/secretscan/rules.py)は正規表現です。最初のキャプチャグループがシークレットです。
汎用ルールでは最小エントロピーも設定されているため、password = "aaaaaaaaaaaa" は検出されません。.git、node_modules、仮想環境、バイナリ(NUL バイトの検出)、
2 MB を超えるファイル、および .secretscanignore に含まれるものはスキップします。git log --all --reverse -p --unified=0 を実行し、diff ストリームを解析して、
各 @@ ハンクヘッダーから現在のコミット、ファイル、新側の行番号を追跡します。+ 行のみがチェックされるため、
シークレットはそれを導入したコミットで一度だけ報告され、以降のすべてのコミットで毎回報告されることはありません。pip install -e ".[dev]"
pytest
ruff check . && ruff format --check .
テストフィクスチャには実際の認証情報は一切含まれていません。tests/fakes.py 内の偽トークンは実行時に断片から組み立てられるため、リポジトリ自体には完全なトークン形式の文字列は含まれません。これにより CI の自己スキャンがクリーンに保たれ、GitLab のプッシュ保護に引っかかることを避けられます。
MIT