Skip to main content

カスタム パターンの管理

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

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

Repository owners, organization owners, security managers, enterprise administrators, and users with the admin role

カスタム パターンを定義して、secret scanning でサポートされているデフォルトのパターンで検出されないシークレットを特定できます。 詳しくは、「シークレット スキャンのカスタム パターンの定義」を参照してください。

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

カスタム パターンの編集

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

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

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

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

  4. 変更を確認してテストしたら、 [Publish changes] (変更の発行) をクリックします。

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

    Note

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

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

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

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

カスタムパターンの削除

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

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

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

Enterprise、Organization、またはリポジトリ レベル で保存されたカスタム パターンのプッシュ保護として、secret scanning を有効にすることができます。

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

Note

  • カスタム パターンのプッシュ保護を有効にするには、エンタープライズ レベルでプッシュ保護として secret scanning を有効にする必要があります。 詳しくは、「プッシュ保護について」を参照してください。
  • 一般的なカスタム パターンに対してプッシュ保護を有効にすると、共同作成者が混乱する可能性があります。

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

  1. GitHub の右上の自分のプロフィール写真をクリックし、[自分の Enterprise] をクリックします。

  2. Enterpriseのリストで、表示したいEnterpriseをクリックしてください。

  3. ページの左側にある Enterprise アカウントのサイドバーで、 [ポリシー] をクリックします。 1. [ポリシー] で、 [コードのセキュリティと分析] をクリックします。

  4. [コードのセキュリティと解析] で、 [セキュリティ機能] をクリックします。 1. [Secret scanning] の [カスタム パターン] で、目的のパターンの をクリックします。

    Note

    Enterprise レベルでは、自分が作成したカスタム パターンのプッシュ保護のみを編集および有効化することができます。

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

    Note

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

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

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

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

  1. GitHub の右上隅で、プロフィール写真を選択し、 あなたの組織をクリックします。

  2. 組織の隣の [設定] をクリックします。

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

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

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

    Note

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

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

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

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

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

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

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

  3. サイドバーの [セキュリティ] セクションで、 [コードのセキュリティと分析] をクリックします。

  4. [コードのセキュリティと分析] の下で、「GitHub Advanced Security」を見つけてください。

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

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

    Note

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

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