Skip to main content

カスタム パターンの管理

カスタム パターンを表示、編集、削除したり、カスタム パターンのプッシュ保護を有効にしたりすることができます。

この機能を使用できるユーザーについて

リポジトリの所有者、organization の所有者、セキュリティ管理者、エンタープライズ管理者、および管理者ロールを持つユーザー

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

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

カスタム パターンの編集

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

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

  2. [カスタム パターン] で、編集するカスタム パターンの右側にある をクリックします。

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

  4. 変更をレビューしてテストしたら、[変更を公開] をクリックします。 データの再利用可能なパターンと高度なセキュリティ:シークレットのスキャンを有効にし、プッシュ保護のカスタムパターン

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

    カスタム パターン ページのスクリーンショット。プッシュ保護を無効にするボタンが濃いオレンジ色の枠線で強調表示されています。

カスタムパターンの削除

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

  1. カスタム パターンが作成された場所に移動します。 カスタム パターンは、リポジトリ、Organization または Enterprise アカウントに作成できます。
  2. 削除するカスタム パターンの右側にある をクリックします。
  3. 確認をレビューし、カスタム パターンに関連する開いているアラートを処理する方法を選択します。
  4.        **[はい、このパターンを削除します]** をクリックします。
    

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

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

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

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

メモ

  • カスタム パターンのプッシュ保護を有効にするには、エンタープライズ レベルでプッシュ保護として 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] をクリックします。1. 組織をクリックして選択します。

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

    組織のプロファイルのタブのスクリーンショット。 [設定] タブが濃いオレンジ色の枠線で囲まれています。

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

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

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

    メモ

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

    カスタム パターン ページの [プッシュ保護] セクションのスクリーンショット。 [有効にする] というボタンが濃いオレンジ色の枠線で囲まれています。

カスタム パターンのプッシュ保護としての secret scanning の有効化

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

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

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

    タブを示すリポジトリ ヘッダーのスクリーンショット。 [設定] タブが濃いオレンジ色の枠線で強調表示されています。

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

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

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

    メモ

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

    カスタム パターン ページの [プッシュ保護] セクションのスクリーンショット。 [有効にする] というボタンが濃いオレンジ色の枠線で囲まれています。