シークレットキーワードフィルターによるノイズ低減

Secret Keyword Filter は、シークレットスキャンのノイズを減らします。ワークスペース管理者は、gitleaks が評価する前に、既知の安全なキーワードを含む行をスキップできます。

このフィルターは 行全体を シークレットスキャンから除外します。慎重に使用してください。広すぎるキーワードは、一致した行上の本物のシークレットを隠してしまう可能性があります。

ユースケース

Secret Keyword Filter を使用するのは次のような場合です:

• 同じ誤検知が多数のファイルやリポジトリにまたがって発生する
• トリガーが、設定キーや変数名のような安定した文字列である
• 行ごとのコメントではなく、ワークスペース全体の設定にしたい

しないでください しません 一般的な許可リストの代替として使わないでください。これは gitleaks の許可リストを補完するものであり、置き換えるものではありません。

Secret Keyword Filter の追加方法

ステップ1。 次へ移動: 設定 → Advanced → シークレットキーワードフィルター で [管理] をクリックします

ステップ 2. キーワードを追加する 入力欄に。複数追加できます。

ステップ 3. 保存してスキャンを実行し、変更を適用します

重要な注意点

• 最小 5 文字: より短いキーワードは拒否されます
• 大文字と小文字を区別します: MySecret と mysecret は別のキーワードです
• 次回のスキャンのみ: 保存した変更は今後のスキャンにのみ適用されます

一致の仕組み

このフィルターは プレーン文字列の一致を使用します。これは しません 正規表現フィルターではありません。

設定したキーワードが行のどこかに現れると、その行全体がシークレット検出から除外されます。

例：

const EXAMPLE_TOKEN = process.env.EXAMPLE_TOKEN;
const apiKey = "sk_live_123456";

もし EXAMPLE_TOKEN がキーワードリストに含まれていると、1行目はスキップされます。2行目は引き続きスキャンされます。

1行目にも本物のシークレットが含まれていた場合、そのシークレットもスキップされてしまいます。フィルターはトークン単位ではなく、行単位で動作します。

ベストプラクティス

• 一般的な用語ではなく、具体的なキーワードを使う
• 設定キーや変数名のような安定した識別子を優先する
• 必要に応じて複数の表記ゆれを追加する
• 保存する前に一致箇所を慎重に確認する
• 変更後は再スキャンして、実際の問題を隠さずにノイズが減ったことを確認する

良い候補:

• EXAMPLE_SENDGRID_KEY
• dummyStripeSecret
• integration_test_token

不向きな候補:

• token
• secret
• auth

代替の抑制方法

Secret Keyword Filter を使うのは 繰り返し発生する、ワークスペース全体の誤検知.

使用します コードコメント を抑制したいときは 既知の安全な 1 行 をコード内で

使用します .aikido ファイルの除外 除外したいときは 特定のファイルやパスを スキャンから