カスタム パターンの管理

カスタム パターンは、 secret scanningでサポートされている既定のパターンで検出されないシークレットを識別するために使用できるユーザー定義パターンです。 詳しくは、「シークレット スキャンのカスタム パターンの定義」をご覧ください。

エンタープライズ レベルでは、カスタム パターンの作成者のみがパターンを編集し、ドライ ランで使用できます。 リポジトリおよび組織レベルでカスタム パターンを編集する場合、同様の制限はありません。

カスタム パターンの編集

カスタム パターンへの変更を保存すると、以前のバージョンのパターンを使用して作成されたすべての シークレット スキャンニング アラート が閉じます。

1. カスタム パターンが作成された場所に移動します。 カスタム パターンは、リポジトリ、Organization または Enterprise アカウントに作成できます。

   • リポジトリまたは organizationは、カスタム パターンが作成されたリポジトリまたは organization の [Advanced Security] の設定を表示します。 詳細については、「リポジトリのカスタム パターンの定義」または「Organization のカスタム パターンの定義」を参照してください。
   • Enterpriseは、[Policies] に [Advanced Security] 領域を表示し、[Security features] をクリックします。 詳細については、「Enterprise アカウントのカスタム パターンの定義」を参照してください。

2.        "カスタム パターン"で、編集するカスタム パターンの右側にある [<svg version="1.1" width="16" height="16" viewBox="0 0 16 16" class="octicon octicon-pencil" aria-label="Edit pattern" role="img"><path d="M11.013 1.427a1.75 1.75 0 0 1 2.474 0l1.086 1.086a1.75 1.75 0 0 1 0 2.474l-8.61 8.61c-.21.21-.47.364-.756.445l-3.251.93a.75.75 0 0 1-.927-.928l.929-3.25c.081-.286.235-.547.445-.758l8.61-8.61Zm.176 4.823L9.75 4.81l-6.286 6.287a.253.253 0 0 0-.064.108l-.558 1.953 1.953-.558a.253.253 0 0 0 .108-.064Zm1.238-3.763a.25.25 0 0 0-.354 0L10.811 3.75l1.439 1.44 1.263-1.263a.25.25 0 0 0 0-.354Z"></path></svg>] をクリックします。
   

3. 編集したカスタム パターンをテストする準備ができたら、アラートを作成せずに一致するものを特定するため、 [保存してドライ ラン] をクリックします。

4. 変更をレビューしてテストしたら、[変更を公開] をクリックします。

5. 任意で、カスタム パターンのプッシュ保護を有効にするには、 [有効にする] をクリックします。

   メモ

   • カスタム パターンのプッシュ保護は、プッシュ保護として secret scanning が有効になっているリポジトリにのみ適用されます。 プッシュ保護の有効化の詳細については、「プッシュ保護について」を参照してください。
   • 一般的なカスタム パターンに対してプッシュ保護を有効にすると、共同作成者が混乱する可能性があります。
   

6. 任意で、カスタム パターンのプッシュ保護を無効にするには、 [Disable] (無効にする) をクリックします。

   

カスタムパターンの削除

カスタム パターンを削除すると、 GitHub には、パターンに関連する シークレット スキャンニング アラート を閉じるか、これらのアラートを保持するかを選択できます。

1. カスタム パターンが作成された場所に移動します。 カスタム パターンは、リポジトリ、Organization または Enterprise アカウントに作成できます。
   • リポジトリまたは organizationは、カスタム パターンが作成されたリポジトリまたは organization の [Advanced Security] の設定を表示します。 詳細については、「リポジトリのカスタム パターンの定義」または「Organization のカスタム パターンの定義」を参照してください。
   • Enterpriseは、[Policies] に [Advanced Security] 領域を表示し、[Security features] をクリックします。 詳細については、「Enterprise アカウントのカスタム パターンの定義」を参照してください。
2. 削除するカスタム パターンの右側にある [ ] をクリックします。
3. 確認をレビューし、カスタム パターンに関連する開いているアラートを処理する方法を選択します。

4.        **[はい、このパターンを削除します]** をクリックします。
   

カスタム パターンを削除するときにアラートを閉じる場合は、削除プロセスがバックグラウンドで非同期的に行われることに注意する必要があります。 大量のアラート (数千以上) を生成したカスタム パターンの場合、削除プロセスが完了するまでに数分から数時間かかる場合があります。 プロセスの完了中に作業を続けることができます。

カスタム パターンのプッシュ保護を有効にする

エンタープライズ、組織、またはリポジトリ レベルで格納されているカスタム パターンのプッシュ保護として、 secret scanning を有効にすることができます。

企業で保存されたカスタム パターンのプッシュ保護を有効にする

エンタープライズ レベルでカスタム パターンのプッシュ保護を有効にする前に、必ず予行演習でもカスタム パターンをテストしてください。 ドライ ランは、自分が管理アクセス権を持つリポジトリでのみ実行できます。 エンタープライズ所有者が、組織内の任意のリポジトリでドライ ランを実行するためのアクセス権を必要とする場合は、組織所有者ロールが割り当てられている必要があります。 詳しくは、「あなたの企業が所有する組織での役割を管理する」をご覧ください。

1. 企業ページに移動してください。 たとえば、GitHub.com の [Enterprise] ページから。

2. ページの上部にある [ Policies] をクリックします。

3. [Policies] で、[Advanced Security] をクリックします。

4. [Advanced Security] の [ セキュリティ機能] をクリックします。

5. [Secret scanning] の [カスタム パターン] で、目的のパターンの をクリックします。

   メモ

   エンタープライズ レベルでは、自分が作成したカスタム パターンに対してのみ、プッシュ保護を編集して有効にすることができます。

6. カスタム パターンのプッシュ保護を有効にするには、[プッシュ保護] まで下にスクロールして、[有効化] をクリックします。

   メモ

   プッシュ保護を有効にするオプションは、公開されたパターンでのみ表示されます。

   

カスタム パターンの組織でプッシュ保護として secret scanning を有効にする

組織レベルでカスタム パターンのプッシュ保護を有効にする前に、組織内でスキャンするリポジトリの secret scanning を有効にする必要があります。 組織内のすべてのリポジトリで secret scanning を有効にするには、 組織のセキュリティおよび分析設定を管理する を参照してください。

1. GitHub の右上隅にあるプロフィール画像をクリックしてから、[ Your organizations] をクリックします。

2. 組織をクリックして選択します。

3. Organization 名の下で、[ Settings] をクリックします。 [設定] タブが表示されない場合は、 [] ドロップダウン メニューを選び、 [設定] をクリックします。

   

4. サイドバーの「セキュリティ」セクションで、 Advanced Security ドロップダウンメニューを選択し、 Global settings をクリックします。

5. [カスタム パターン] で、目的のパターンの をクリックします。

6. カスタム パターンのプッシュ保護を有効にするには、[プッシュ保護] まで下にスクロールして、[有効化] をクリックします。

   メモ

   • プッシュ保護を有効にするオプションは、公開されたパターンでのみ表示されます。
   • カスタム パターンのプッシュ保護は、プッシュ保護として secret scanning が有効になっている組織のリポジトリにのみ適用されます。
   • 一般的なカスタム パターンに対してプッシュ保護を有効にすると、共同作成者が混乱する可能性があります。
   

カスタム パターンのリポジトリでプッシュ保護として secret scanning を有効にする

リポジトリ レベルでカスタム パターンのプッシュ保護を有効にする前に、リポジトリのカスタム パターンを定義し、それをリポジトリ内でテストする必要があります。 詳しくは、「シークレット スキャンのカスタム パターンの定義」をご覧ください。

1. GitHub で、リポジトリのメイン ページに移動します。

2. リポジトリ名の下にある [Settings] をクリックします。 [設定] タブが表示されない場合は、 [] ドロップダウン メニューを選び、 [設定] をクリックします。

   

3. サイドバーの [Security] セクションで、[ Advanced Security] をクリックします。

4. [Secret Protection] の [カスタム パターン] で、目的のパターンの をクリックします。

5. カスタム パターンのプッシュ保護を有効にするには、[プッシュ保護] まで下にスクロールして、[有効化] をクリックします。

   メモ

   プッシュ保護を有効にするオプションは、公開されたパターンでのみ表示されます。