secret scanningについて
プロジェクトを外部サービスと通信させる場合、認証にトークンまたは秘密鍵を使用できます。 トークンや秘密鍵は、サービスプロバイダが発行できるシークレットです。 リポジトリにシークレットをチェックインする場合、リポジトリへの読み取りアクセスを持つすべてのユーザがシークレットを使用して、自分の権限で外部サービスにアクセスできます。 シークレットは、プロジェクトのリポジトリの外の、安全な専用の場所に保存することをお勧めします。
Secret scanningでは、シークレットの GitHub リポジトリ (リポジトリがアーカイブされている場合も含む) に存在するすべてのブランチ上の Git 履歴全体がスキャンされます。 Secret scanning では、シークレットの問題の説明とコメントも分析されます。
Secret scanning では、未解決の issue と解決済みの過去の issue でタイトル、説明、コメントがスキャンされ、漏洩したシークレットが GitHub でアラートとして報告されます。 履歴パートナー パターンが検出されると、関連するパートナーに通知が送信されます。
注: 現在、過去のシークレット漏えいに対する Secret scanning はパブリック ベータ段階であり、変更される可能性があります。
Secret scanningは、GitHub.com で次の 2 つの形式で使用できます。
-
パートナーに対するシークレット スキャン アラート. すべてのパブリック リポジトリとパブリック npm パッケージで自動的に実行されます。 シークレット スキャン パートナーによって指定されたパターンと一致するすべての文字列が、関連するパートナーに直接報告されます。 詳細については、以下の「パートナーに対するシークレット スキャン アラート について」セクションを参照してください。
-
ユーザーに対するシークレット スキャン アラート. GitHub Enterprise Cloud を使う組織が所有するリポジトリについて、パブリック リポジトリに対して (無料)、また GitHub Advanced Security のライセンスがある場合はプライベート リポジトリと内部リポジトリに対して、追加のスキャンを有効にして構成できます。
シークレット スキャン パートナーが指定したか、その他のサービス プロバイダーが指定したか、自分または自分の Organization が定義したパターンに一致する文字列は、リポジトリの [セキュリティ] タブでアラートとして報告されます。 パブリック リポジトリ内の文字列がパートナー パターンと一致する場合は、パートナーにも報告されます。 詳細については、以下の「ユーザーに対するシークレット スキャン アラート について」セクションを参照してください。
GitHub ツールを使用して、secret scanning アラートに応答して実行されたアクションを監査できます。 詳しくは、「セキュリティ アラートの監査」を参照してください。
サービス プロバイダーは GitHub と提携して、スキャンのためのシークレット フォーマットを指定することができます。 パートナー プログラムについては、「Secret scanningパートナープログラム」を参照してください。
また、リポジトリまたは組織のプッシュ保護としてsecret scanningを有効にすることもできます。 この機能を有効にすると、secret scanningでは、共同作成者が検出済みのシークレットを含むコードをプッシュできなくなります。 続行するには、共同作成者がプッシュからシークレットを削除するか、必要に応じて保護をバイパスします。 また、管理者は、push がブロックされると共同作成者に表示されるカスタム リンクを指定することもできます。このリンクには、共同作成者を支援するための Organization 固有のリソースが含まれています。 詳しくは、「シークレット スキャンによるプッシュの保護」をご覧ください。
パートナーに対するシークレット スキャン アラート について
リポジトリをパブリックにするか、パブリック リポジトリに変更をプッシュすると、GitHub Enterprise Cloud では常にコードがスキャンされて、パートナー パターンと一致するシークレットがないか確認されます。 npm レジストリのパブリック パッケージもスキャンされます。 Secret scanning では、シークレットの問題の説明とコメントも分析されます。 secret scanning によって潜在的シークレットが検出された場合、シークレットを発行したサービス プロバイダーに通知します。 サービス プロバイダーは文字列を検証してから、シークレットを取り消すか、新しいシークレットを発行するか、または直接連絡するかを決定します。 その対応は、ユーザーまたはプロバイダーに関連するリスクによって決まります。 詳しくは、「secret scanning パターン」を参照してください。
パブリック リポジトリ上のパートナー パターンの secret scanning の構成を変更することはできません。
ユーザーに対するシークレット スキャン アラートについて
ユーザーに対するシークレット スキャン アラート は、すべてのパブリック リポジトリに対して無料で、また GitHub Enterprise Cloud を使い、GitHub Advanced Security のライセンスを持つ組織が所有するプライベート リポジトリと内部リポジトリに対して利用できます。リポジトリに対して secret scanning を有効にする場合、GitHub によって、多くのサービス プロバイダーが使うシークレットに一致するパターンがコードでスキャンされます。 スキャンが完了すると、GitHub は、シークレットが見つからなかった場合でも、エンタープライズおよび組織の所有者にメール アラートを送信します。
Secret scanning では、シークレットの問題の説明とコメントも分析されます。サポートされているシークレットが漏洩した場合、GitHub Enterprise Cloud は、secret scanning アラートを生成します。 GitHub では、secret scanning が有効になっている GitHub Advanced Security リポジトリ内の既存のコンテンツの完全な Git 履歴スキャンも定期的に実行され、secret scanning アラート通知設定に従ってアラート通知が送信されます。 詳細については、「ユーザー アラートに対してサポートされているシークレット」を参照してください。
注: Issue の説明とコメントの Secret scanning はパブリック ベータ版であり、変更される可能性があります。
リポジトリ管理者は、任意のリポジトリ (アーカイブされたリポジトリを含む) に対して ユーザーに対するシークレット スキャン アラート を有効にすることができます。 組織の所有者は、すべてのリポジトリ、または組織内のすべての新しいリポジトリに対して ユーザーに対するシークレット スキャン アラート を有効にすることもできます。 詳細については、「リポジトリのセキュリティと分析設定を管理する」および「Organization のセキュリティおよび分析設定を管理する」を参照してください。
リポジトリ、組織、またはエンタープライズ用のカスタム secret scanning パターンを定義することもできます。 詳しくは、GitHub Enterprise Cloud ドキュメントの「シークレット スキャンのカスタム パターンの定義
GitHub は、転送中と保存時の両方で対称暗号化を使用して検出されたシークレットを格納します。
シークレット スキャン アラート へのアクセス
リポジトリの secret scanningを有効にする、または secret scanningが有効になっているリポジトリにコミットをプッシュすると、GitHub によってそれらのコミットの内容がスキャンされて、サービス プロバイダーで定義されているパターン、および Enterprise、Organization、またはリポジトリで定義されているカスタム パターンと一致するシークレットが確認されます。 Secret scanning では、シークレットの問題の説明とコメントも分析されます。 GitHub では、新たなパートナー パターンやカスタム パターンが追加または更新される際に secret scanning が有効になっているリポジトリ内のすべての履歴コード コンテンツのスキャンも実行されます。
secret scanningでシークレットが検出されると、GitHub によってアラートが送信されます。
- GitHub は、リポジトリ管理者と Organizationのオーナーにメールアラートを送信します。 リポジトリ を監視しており、セキュリティ アラートまたはリポジトリ上のすべてのアクティビティに対して、および通知設定で通知を有効にしている場合、監視しているリポジトリに関してメール通知を受け取るよう選択済みの場合、アラートが通知されます。
- シークレットをコミットしたコントリビューターがリポジトリを無視していない場合も、GitHub によってコントリビューターにメール アラートが送信されます。 メールには、関連する secret scanning アラートへのリンクが含まれています。 コミット作者は、リポジトリでこのアラートを表示して、アラートを解決できます。
- GitHub のリポジトリの [セキュリティ] タブにアラートが表示されます。
シークレット スキャン アラート の表示と解決について詳しくは、「シークレット スキャンからのアラートの管理」を参照してください。
シークレット スキャン アラート の通知を構成する方法の詳細については、「シークレット スキャン アラートの通知を構成する」を参照してください。
リポジトリ管理者と組織所有者は、ユーザーおよびチームに シークレット スキャン アラート へのアクセスを許可できます。 詳しくは、「リポジトリのセキュリティと分析設定を管理する」を参照してください。
セキュリティの概要を使って、secret scanning が有効になっているリポジトリと検出されたアラートの組織レベルのビューを表示できます。 詳しくは、「セキュリティの概要について」を参照してください。
また、REST API を使って、リポジトリ全体でsecret scanningからの結果を監視できます。 API エンドポイントについて詳しくは、「シークレット スキャン」を参照してください。