secret-scan
プロジェクト内のシークレットファイルをスキャンし、.gitignore の保護状況を監査する。
Instructions
Step 1: シークレットファイル候補の検出
以下のパターンに該当するファイルをプロジェクト内から検索する。
ファイル名パターン:
.env, .env.*, .env.local, .env.production, .env.staging
credentials.json, credentials.yml, credentials.yaml
secrets.json, secrets.yml, secrets.yaml, secrets.toml
service-account*.json, serviceAccountKey*.json
.netrc, .npmrc
.docker/config.json
token.json, tokens.json, auth.json, oauth*.json
.htpasswd, .htaccess, wp-config.php, database.yml
拡張子パターン:
*.pem, *.key, *.p12, *.pfx, *.jks, *.keystore
*.p8, *.gpg, *.asc
ディレクトリパターン:
.ssh/, .gnupg/, .aws/, .gcloud/ 配下
検索には Glob と Bash (find 相当) を使用する。
node_modules, .git, vendor, dist, build は除外する。
Step 2: .gitignore との突合せ
検出した各ファイルについて:
.gitignore を読み取る(存在しない場合は警告)
- 各シークレットファイルが .gitignore でカバーされているか判定
- 結果を以下のカテゴリに分類:
- 保護済み: .gitignore に登録されている
- 未保護: .gitignore に登録されていない(要対応)
- git追跡済み: 既に git tracking されている(危険)
git tracking 状態の確認:
git ls-files --error-unmatch <filepath> 2>/dev/null
Step 3: レポート出力
スキャン結果をユーザーに提示する。
フォーマット:
## secret-guard スキャン結果
### 検出されたシークレットファイル: N 件
#### 保護済み (gitignore 登録済み)
- .env (パターン: .env)
- credentials.json (パターン: credentials.json)
#### 未保護 (要対応)
- .env.local (gitignore に未登録)
- secrets.yaml (gitignore に未登録)
#### 警告: git 追跡済み (危険)
- config/database.yml (既にコミット済み)
### 推奨アクション
1. 未保護ファイルを .gitignore に追加
2. git 追跡済みファイルを git rm --cached で除外
Step 4: .gitignore の修正提案
未保護のファイルが見つかった場合:
- AskUserQuestion で .gitignore への追加をユーザーに確認
- 承認された場合、.gitignore にパターンを追加
- 追加時はコメント付きで、secret-guard セクションとしてまとめる:
# === secret-guard: シークレットファイル保護 ===
.env
.env.*
credentials.json
*.pem
*.key
# === /secret-guard ===
Step 5: git 追跡済みファイルへの対処
git で既に追跡されているシークレットファイルが見つかった場合:
- ユーザーに警告と対処法を提示
git rm --cached <file> の実行をユーザーに提案(AI は直接実行しない)
- コミット履歴からの削除が必要な場合は
git filter-branch や BFG Repo-Cleaner を案内
--fix モード
引数に --fix が含まれる場合:
- Step 4 のユーザー確認をスキップし、自動的に .gitignore を更新
- ただし git 追跡済みファイルの操作は常にユーザー確認必須
Examples
標準スキャン(対話モード)
ユーザー: 「このリポジトリのシークレット保護状態をチェックして」
- Step 1 で
.env*, *.pem, credentials.* 等を検出
- Step 2 で
.gitignore と突合し 保護済み / 未保護 / git 追跡済み に分類
- Step 3 のレポートを提示
- 未保護があれば Step 4 の AskUserQuestion で追加可否を確認
- git 追跡済みが見つかれば
git rm --cached の手順を警告付きで案内
--fix モードで自動修正
ユーザー: /secret-guard:scan --fix
- Step 1〜3 を通常通り実行
- Step 4 の確認をスキップし、未保護ファイルのパターンを
.gitignore の
# === secret-guard === セクションへ追記
- git 追跡済みファイルは自動処理せず、ユーザーへ
git rm --cached を提示
- 完了後に変更件数と残課題をレポート
既に漏洩しているファイルの検出
ユーザー: 「誤って commit してしまったかも」
- Step 1 で候補ファイルを列挙
git ls-files --error-unmatch で追跡済みを識別
- Step 5 に従い警告と履歴削除の選択肢(
git filter-branch / BFG)を提示
- キーのローテーション必要性をユーザーに念押し
1---2name: secret-scan3description: Use when user wants to check secret protection, audit gitignore, scan for exposed secrets, or check security status. プロジェクトのシークレット保護状況をスキャン・監査し、.gitignore の漏れを検出し保護が必要なファイルを特定してレポートする。4allowed-tools: Bash, Read, Glob, Grep, Write, Edit, AskUserQuestion5metadata:6 source: https://skillmd.com/skills/biwakonbu/secret-scan7---89# secret-scan1011プロジェクト内のシークレットファイルをスキャンし、.gitignore の保護状況を監査する。1213## Instructions1415### Step 1: シークレットファイル候補の検出1617以下のパターンに該当するファイルをプロジェクト内から検索する。1819**ファイル名パターン:**20- `.env`, `.env.*`, `.env.local`, `.env.production`, `.env.staging`21- `credentials.json`, `credentials.yml`, `credentials.yaml`22- `secrets.json`, `secrets.yml`, `secrets.yaml`, `secrets.toml`23- `service-account*.json`, `serviceAccountKey*.json`24- `.netrc`, `.npmrc`25- `.docker/config.json`26- `token.json`, `tokens.json`, `auth.json`, `oauth*.json`27- `.htpasswd`, `.htaccess`, `wp-config.php`, `database.yml`2829**拡張子パターン:**30- `*.pem`, `*.key`, `*.p12`, `*.pfx`, `*.jks`, `*.keystore`31- `*.p8`, `*.gpg`, `*.asc`3233**ディレクトリパターン:**34- `.ssh/`, `.gnupg/`, `.aws/`, `.gcloud/` 配下3536検索には Glob と Bash (`find` 相当) を使用する。37`node_modules`, `.git`, `vendor`, `dist`, `build` は除外する。3839### Step 2: .gitignore との突合せ4041検出した各ファイルについて:42431. `.gitignore` を読み取る(存在しない場合は警告)442. 各シークレットファイルが .gitignore でカバーされているか判定453. 結果を以下のカテゴリに分類:46 - **保護済み**: .gitignore に登録されている47 - **未保護**: .gitignore に登録されていない(要対応)48 - **git追跡済み**: 既に git tracking されている(危険)4950git tracking 状態の確認:51```bash52git ls-files --error-unmatch <filepath> 2>/dev/null53```5455### Step 3: レポート出力5657スキャン結果をユーザーに提示する。5859フォーマット:60```61## secret-guard スキャン結果6263### 検出されたシークレットファイル: N 件6465#### 保護済み (gitignore 登録済み)66- .env (パターン: .env)67- credentials.json (パターン: credentials.json)6869#### 未保護 (要対応)70- .env.local (gitignore に未登録)71- secrets.yaml (gitignore に未登録)7273#### 警告: git 追跡済み (危険)74- config/database.yml (既にコミット済み)7576### 推奨アクション771. 未保護ファイルを .gitignore に追加782. git 追跡済みファイルを git rm --cached で除外79```8081### Step 4: .gitignore の修正提案8283未保護のファイルが見つかった場合:84851. AskUserQuestion で .gitignore への追加をユーザーに確認862. 承認された場合、.gitignore にパターンを追加873. 追加時はコメント付きで、secret-guard セクションとしてまとめる:8889```gitignore90# === secret-guard: シークレットファイル保護 ===91.env92.env.*93credentials.json94*.pem95*.key96# === /secret-guard ===97```9899### Step 5: git 追跡済みファイルへの対処100101git で既に追跡されているシークレットファイルが見つかった場合:1021031. ユーザーに警告と対処法を提示1042. `git rm --cached <file>` の実行をユーザーに提案(AI は直接実行しない)1053. コミット履歴からの削除が必要な場合は `git filter-branch` や `BFG Repo-Cleaner` を案内106107## --fix モード108109引数に `--fix` が含まれる場合:110- Step 4 のユーザー確認をスキップし、自動的に .gitignore を更新111- ただし git 追跡済みファイルの操作は常にユーザー確認必須112113## Examples114115### 標準スキャン(対話モード)116117ユーザー: 「このリポジトリのシークレット保護状態をチェックして」1181191. Step 1 で `.env*`, `*.pem`, `credentials.*` 等を検出1202. Step 2 で `.gitignore` と突合し 保護済み / 未保護 / git 追跡済み に分類1213. Step 3 のレポートを提示1224. 未保護があれば Step 4 の AskUserQuestion で追加可否を確認1235. git 追跡済みが見つかれば `git rm --cached` の手順を警告付きで案内124125### --fix モードで自動修正126127ユーザー: `/secret-guard:scan --fix`1281291. Step 1〜3 を通常通り実行1302. Step 4 の確認をスキップし、未保護ファイルのパターンを `.gitignore` の131 `# === secret-guard ===` セクションへ追記1323. git 追跡済みファイルは自動処理せず、ユーザーへ `git rm --cached` を提示1334. 完了後に変更件数と残課題をレポート134135### 既に漏洩しているファイルの検出136137ユーザー: 「誤って commit してしまったかも」1381391. Step 1 で候補ファイルを列挙1402. `git ls-files --error-unmatch` で追跡済みを識別1413. Step 5 に従い警告と履歴削除の選択肢(`git filter-branch` / BFG)を提示1424. キーのローテーション必要性をユーザーに念押し