# シークレット スキャンのカスタム パターンの定義
正規表現を使用してカスタム パターンを定義することで、一意のシークレットの種類を保護します。
## を使用してカスタム パターンを定義する Copilot
AI を使用すると、検出する必要がある文字列の例 (省略可能) など、検出するパターンの種類のテキスト記述に基づいて正規表現を生成できます。 「[AI を使用したカスタム パターンの正規表現の生成](/ja/code-security/how-tos/secure-your-secrets/customize-leak-detection/generating-regular-expressions-for-custom-patterns-with-ai)」を参照してください。
## リポジトリのカスタムパターンの定義
カスタム パターンを定義する前に、リポジトリで Secret Protection が有効になっていることを確認する必要があります。 詳細については、「[リポジトリのシークレット スキャンの有効化](/ja/code-security/how-tos/secure-your-secrets/detect-secret-leaks/enable-secret-scanning)」を参照してください。
1. GitHub で、リポジトリのメイン ページに移動します。
2. リポジトリ名の下にある ** \[Settings]** をクリックします。 \[設定] タブが表示されない場合は、 **\[]** ドロップダウン メニューを選び、 **\[設定]** をクリックします。
![タブを示すリポジトリ ヘッダーのスクリーンショット。 \[設定\] タブが濃いオレンジ色の枠線で強調表示されています。](/assets/images/help/repository/repo-actions-settings.png)
3. サイドバーの \[セキュリティと品質] セクションで、\[ **Advanced Security**] をクリックします。
4. \[Secret Protection] の \[カスタム パターン] の右側にある \[ **新しいパターン**] をクリックします。
5. 新しいカスタム パターンの詳細を入力します。 少なくともパターンの名前と、シークレットパターンのフォーマットとして正規表現を提供しなければなりません。
1. \[Pattern name] (パターン名) フィールドにパターンの名前を入力します。
2. \[シークレット形式] フィールドに、シークレット パターンの形式の正規表現を入力します。
3. \[ **その他のオプション] ** をクリックすると、その他の周囲のコンテンツやシークレット形式の追加の一致要件を指定できます。 「[カスタム パターン リファレンス](/ja/code-security/reference/secret-security/custom-patterns#syntax-for-manually-defining-custom-patterns)」を参照してください。
4. サンプルのテスト文字列を指定し、設定内容が期待するパターンにマッチすることを確認できます。
6. 新しいカスタム パターンをテストする準備ができたら、アラートを作成せずにリポジトリで一致するものを特定するために、 **\[保存してドライ ラン]** をクリックします。
7. ドライ ランが完了すると、結果のサンプル (最大 1000 個) が表示されます。 結果をレビューし、誤検知の結果を特定します。
8. 新しいカスタム パターンを編集して結果に関するすべての問題を修正してから、 **\[保存してドライ ラン]** をクリックして変更をテストします。
9. 新しいカスタム パターンに問題がなければ、 **\[パターンの発行]** をクリックします。
10. 任意で、カスタム パターンのプッシュ保護を有効にするには、 **\[有効にする]** をクリックします。 詳細については、「[プッシュプロテクション](/ja/code-security/concepts/secret-security/push-protection)」を参照してください。
> \[!NOTE]
> ドライ ランが成功し、パターンを公開するまで、\[Enable] ボタンは使用できません。
パターンが作成されたら、 secret scanningはGitHubリポジトリ中に存在するすべてのブランチのGit履歴全体に対して、あらゆるシークレットをスキャンします。シークレット スキャンニング アラートの表示の詳細については、「 [シークレット スキャン アラートの管理](/ja/code-security/how-tos/manage-security-alerts/manage-secret-scanning-alerts)」を参照してください。
## 組織のカスタムパターンの定義
カスタム パターンを定義する前に、組織内でスキャンするリポジトリの secret scanning を有効にする必要があります。\
security configurationsを使用して、組織内のすべてのリポジトリでsecret scanningを有効にすることができます。 詳細については、「[大規模なセキュリティ機能の有効化](/ja/code-security/concepts/security-at-scale/organization-security)」を参照してください。
1. GitHub の右上隅にあるプロフィール画像をクリックしてから、**\[ Your organizations]** をクリックします。
2. 組織をクリックして選択します。
3. Organization 名の下で、**\[ Settings]** をクリックします。 \[設定] タブが表示されない場合は、 **\[]** ドロップダウン メニューを選び、 **\[設定]** をクリックします。
![組織のプロファイルのタブのスクリーンショット。 \[設定\] タブが濃いオレンジ色の枠線で囲まれています。](/assets/images/help/discussions/org-settings-global-nav-update.png)
4. サイドバーの「セキュリティ」セクションで、 **Advanced Security** ドロップダウンメニューを選択し、 **Global settings** をクリックします。
5. \[カスタム パターン] で、\[ **新しいパターン**] をクリックします。
6. 新しいカスタム パターンの詳細を入力します。 少なくともパターンの名前と、シークレットパターンのフォーマットとして正規表現を提供しなければなりません。
1. \[Pattern name] (パターン名) フィールドにパターンの名前を入力します。
2. \[シークレット形式] フィールドに、シークレット パターンの形式の正規表現を入力します。
3. \[ **その他のオプション] ** をクリックすると、その他の周囲のコンテンツやシークレット形式の追加の一致要件を指定できます。 「[カスタム パターン リファレンス](/ja/code-security/reference/secret-security/custom-patterns#syntax-for-manually-defining-custom-patterns)」を参照してください。
4. サンプルのテスト文字列を指定し、設定内容が期待するパターンにマッチすることを確認できます。
7. 新しいカスタム パターンをテストする準備ができたら、アラートを作成せずにリポジトリの選択で一致するものを特定するために、 **\[保存してドライ ラン]** をクリックします。
8. ドライ ランを実行するリポジトリを選びます。
* 組織全体でドライ ランを実行するには、**\[組織内のすべてのリポジトリ]** を選択します。
* ドライ ランを実行するリポジトリを指定するには、 **\[選択済みリポジトリ]** を選び、最大 10 個のリポジトリを検索して選びます。
9. 新しいカスタム パターンをテストする準備ができたら、 **\[実行]** をクリックします。
10. ドライ ランが完了すると、結果のサンプル (最大 1000 個) が表示されます。 結果をレビューし、誤検知の結果を特定します。
11. 新しいカスタム パターンを編集して結果に関するすべての問題を修正してから、 **\[保存してドライ ラン]** をクリックして変更をテストします。
12. 新しいカスタム パターンに問題がなければ、 **\[パターンの発行]** をクリックします。
13. 任意で、カスタム パターンのプッシュ保護を有効にするには、 **\[有効にする]** をクリックします。 詳細については、「[プッシュプロテクション](/ja/code-security/concepts/secret-security/push-protection#customization)」を参照してください。
> \[!NOTE]
>
> * プッシュ保護を有効にするオプションは、公開されたパターンでのみ表示されます。
> * カスタム パターンのプッシュ保護は、プッシュ保護として secret scanning が有効になっている組織のリポジトリにのみ適用されます。
> * 一般的なカスタム パターンに対してプッシュ保護を有効にすると、共同作成者が混乱する可能性があります。
パターンが作成されたら、 secret scanning は、組織内のリポジトリ内のすべてのシークレット (すべてのブランチでの Git 履歴全体を含む) をスキャンします。 Organization の所有者とリポジトリの管理者は、シークレットが見つかるとアラートを受け、シークレットが見つかったリポジトリでアラートをレビューできます。
シークレット スキャンニング アラートの表示の詳細については、「[シークレット スキャン アラートの管理](/ja/code-security/how-tos/manage-security-alerts/manage-secret-scanning-alerts)」を参照してください。
## Enterprise アカウントのカスタム パターンの定義
> \[!NOTE]
>
> * エンタープライズ レベルでは、カスタム パターンの作成者のみがパターンを編集し、ドライ ランで使用できます。
> * ドライ ランは、自分が管理アクセス権を持つリポジトリでのみ実行できます。 エンタープライズ所有者が、組織内の任意のリポジトリでドライ ランを実行するためのアクセス権を必要とする場合は、組織所有者ロールが割り当てられている必要があります。 詳しくは、「[あなたの企業が所有する組織での役割を管理する](/ja/enterprise-cloud@latest/admin/managing-accounts-and-repositories/managing-organizations-in-your-enterprise/managing-your-role-in-an-organization-owned-by-your-enterprise)」をご覧ください。
1. 企業ページに移動してください。 たとえば、GitHub.com の [\[Enterprise\]](https://github.com/settings/enterprises?ref_product=ghec\&ref_type=engagement\&ref_style=text) ページから。
2. ページの上部にある \[**ポリシーの**] をクリックします。
3. \[Policies] で、**\[Advanced Security Code security]** をクリックします。
4. \[Advanced Security Code security] の \[ **セキュリティ機能**] をクリックします。
5. \[シークレット スキャン カスタム パターン] で、 **\[新しいパターン]** をクリックします。
6. 新しいカスタム パターンの詳細を入力します。 少なくともパターンの名前と、シークレットパターンのフォーマットとして正規表現を提供しなければなりません。
1. \[Pattern name] (パターン名) フィールドにパターンの名前を入力します。
2. \[シークレット形式] フィールドに、シークレット パターンの形式の正規表現を入力します。
3. \[ **その他のオプション] ** をクリックすると、その他の周囲のコンテンツやシークレット形式の追加の一致要件を指定できます。 「[カスタム パターン リファレンス](/ja/code-security/reference/secret-security/custom-patterns#syntax-for-manually-defining-custom-patterns)」を参照してください。
4. サンプルのテスト文字列を指定し、設定内容が期待するパターンにマッチすることを確認できます。
7. 新しいカスタム パターンをテストする準備ができたら、アラートを作成せずに Enterprise で一致するものを特定するため、 **\[保存してドライ ラン]** をクリックします。
8. ドライ ランを実行するリポジトリを最大 10 個検索して選択します。
9. 新しいカスタム パターンをテストする準備ができたら、 **\[実行]** をクリックします。
10. ドライ ランが完了すると、結果のサンプル (最大 1000 個) が表示されます。 結果をレビューし、誤検知の結果を特定します。
11. 新しいカスタム パターンを編集して結果に関するすべての問題を修正してから、 **\[保存してドライ ラン]** をクリックして変更をテストします。
12. 新しいカスタム パターンに問題がなければ、 **\[パターンの発行]** をクリックします。
13. 任意で、カスタム パターンのプッシュ保護を有効にするには、 **\[有効にする]** をクリックします。 詳細については、「[プッシュプロテクション](/ja/code-security/concepts/secret-security/push-protection)」を参照してください。
> \[!NOTE]
>
> * カスタム パターンのプッシュ保護を有効にするには、エンタープライズ レベルでプッシュ保護として secret scanning を有効にする必要があります。
> * 一般的なカスタム パターンに対してプッシュ保護を有効にすると、共同作成者が混乱する可能性があります。
パターンが作成されたら、 secret scanning は、すべてのブランチの Git 履歴全体を含め、 GitHub Secret Protection が有効になっている組織内のリポジトリ内のシークレットをスキャンします。 Organization の所有者とリポジトリの管理者は、シークレットが見つかるとアラートを受け、シークレットが見つかったリポジトリでアラートをレビューできます。
シークレット スキャンニング アラートの表示の詳細については、「[シークレット スキャン アラートの管理](/ja/code-security/how-tos/manage-security-alerts/manage-secret-scanning-alerts)」を参照してください。