概要
このガイドは、リポジトリでのセキュリティ機能の設定方法を紹介します。
セキュリティの要件はリポジトリに固有のものなので、リポジトリですべての機能を有効化する必要はないかもしれません。 詳しくは、「GitHub セキュリティ機能」をご覧ください。
一部の機能は、すべてのプランのリポジトリに使用できます。 GitHub Secret Protection, GitHub Code Security, or GitHub Advanced Security を使う organization や Enterprise は、その他の機能を使用できます。 GitHub Advanced Security 機能は、GitHub 上のすべてのパブリック リポジトリでも有効になります。 詳しくは、「GitHub Advanced Security について」をご覧ください。
リポジトリへのアクセスの管理
リポジトリを保護するための最初の手順は、誰がコードを表示および変更できるかを確立することです。 詳しくは、「リポジトリの設定と機能を管理する」をご覧ください。
リポジトリのメイン ページから、 [設定] をクリックし、[危険区域] まで下にスクロールします。
- リポジトリを表示できるユーザーを変更するには、 [可視性の変更] をクリックします。 詳しくは、「リポジトリの可視性を設定する」をご覧ください。
- リポジトリにアクセスできるユーザーを変更し、権限を調整するには、 [アクセスの管理] をクリックします。 詳しくは、「リポジトリへのアクセス権を持つ Team と人を管理する」をご覧ください。
依存関係グラフの管理
リポジトリ管理者は、リポジトリに対して依存関係グラフを有効または無効にすることができます。依存関係グラフでは、リポジトリ内のマニフェストとロック ファイルが解釈されて依存関係が識別されます。
- リポジトリのメイン ページから、 [設定] をクリックします。
- [Advanced Security] をクリックします。
- 依存関係グラフの横にある [有効化] または [無効化] をクリックします。
詳しくは、「リポジトリの依存関係を調べる」をご覧ください。
Dependabot alertsの管理
GitHub によって脆弱性のある依存関係が依存関係グラフで特定されたときに、Dependabot alerts が生成されます。 任意のリポジトリに対して、Dependabot alerts を有効にすることができます。
さらに、Dependabot 自動トリアージ ルール を使用してアラートを大規模に管理できるため、アラートを自動的に閉じたりスヌーズしたりして、pull requestを開く Dependabot アラートを指定できます。 さまざまな種類の自動トリアージ ルールと、リポジトリが適格かどうかについては、「Dependabot 自動トリアージ ルールについて」を参照してください。
Dependabot によって提供されるさまざまな機能の概要と、開始方法の手順については、「Dependabot クイックスタート ガイド」を参照してください。
詳細については、「Dependabot アラートについて」と「セキュリティと分析機能の管理」 を参照してください。
依存関係レビューの管理
依存関係レビューを使うと、Pull Requestがリポジトリにマージされる前に、Pull Request内での依存関係の変化を可視化できます。 詳しくは、「依存関係の確認について」をご覧ください。
依存関係レビューは % data variables.product.prodname_GH_code_security %} 機能です。 依存関係レビューは、依存関係グラフが有効になっているすべてのリポジトリに対して有効になります。 GitHub Code Security で GitHub Team または GitHub Enterprise Cloud を使う organization は、さらにプライベートおよび内部リポジトリで依存関係レビューを有効にできます。
リポジトリの依存関係の確認を有効にするには、依存関係グラフが有効になっていることを確認します。
- リポジトリのメイン ページから、 [設定] をクリックします。
- [Advanced Security] をクリックします。
- [Code Security] の右側にある [有効化] をクリックします。
- Code Security で、リポジトリに対して依存関係グラフが有効になっていることを確認します。
Dependabot security updatesの管理
Dependabot alerts を使用するリポジトリでは、Dependabot security updates を有効化して脆弱性が検出された際にセキュリティ更新で Pull Request を発行させることができます。
- リポジトリのメイン ページから、 [設定] をクリックします。
- [Advanced Security] をクリックします。
- Dependabot security updates の横にある [有効化] をクリックします。
詳細については、「Dependabot のセキュリティ アップデート」および「Dependabot セキュリティの更新の構成」を参照してください。
Dependabot version updatesの管理
Dependabotを有効化して、依存関係を最新の状態に保つためのPull Requestを自動的に発行するようにできます。 詳しくは、「GitHub Dependabot のバージョンアップデートについて」をご覧ください。
- リポジトリのメイン ページから、 [設定] をクリックします。
- [Advanced Security] をクリックします。
- Dependabot version updates
の横にある [有効] をクリックして、基本的な
dependabot.yml構成ファイルを作成します。 - 更新する依存関係および、すべての関連する構成オプションを指定したら、ファイルをリポジトリにコミットします。 詳しくは、「Dependabot バージョンの更新の構成」をご覧ください。
Code Security の構成
GitHub Code Security には、code scanning、CodeQL CLI、Copilotの自動修正 と、コードベースの脆弱性を検出して修正するその他の機能が含まれています。
CodeQL 分析ワークフロー もしくはサードパーティのツールを使い、リポジトリ中に保存されたコードの脆弱性やエラーを自動的に特定するよう、code scanningを構成できます。 リポジトリのプログラミング言語によっては、既定の設定を使って code scanning と CodeQL を構成でき、その場合、スキャンする言語、実行するクエリ スイート、新しいスキャンをトリガーするイベントは、GitHub によって自動的に決定されます。 詳しくは、「コード スキャンの既定セットアップの構成」をご覧ください。
- リポジトリのメイン ページから、 [設定] をクリックします。
- サイドバーの [セキュリティ] セクションで、 [Advanced Security] をクリックします。
- [Code Security] または [GitHub Advanced Security] がまだ有効になっていない場合は、[有効化] をクリックします。
- [CodeQL 分析] の右側にある [設定] を選んでから、[既定] をクリックします。
- 表示されるポップアップ ウィンドウで、リポジトリの既定の構成設定を確認し、 [CodeQL を有効にする] をクリックします。
- Copilotの自動修正 などの追加機能を有効にするかどうかを選びます。
既定のセットアップの代わりに、編集可能なワークフロー ファイルを生成する詳細設定を使用して、CodeQL を使用してcode scanningをカスタマイズすることもできます。 詳しくは、「コード スキャンの高度なセットアップの構成」をご覧ください。
Secret Protectionの構成
GitHub Secret Protection には、secret scanning とプッシュ保護、およびリポジトリ内のシークレット漏洩の検出と防止に役立つその他の機能が含まれています。
- リポジトリのメイン ページから、 [設定] をクリックします。
- [Advanced Security] をクリックします。
- [Secret Protection] または [GitHub Advanced Security] がまだ有効になっていない場合は、[有効化] をクリックします。
- オプション [Secret scanning] が表示されている場合は、[有効か] をクリックします。
- プロバイダー以外のパターンのスキャン、プッシュ保護などの追加機能を有効にするかどうかを選びます。
セキュリティポリシーの設定
リポジトリの保守管理者であれば、リポジトリに SECURITY.md という名前のファイルを作成して、リポジトリのセキュリティ ポリシーを指定することをお勧めします。 このファイルは、ユーザーがリポジトリのセキュリティ脆弱性を報告したいときに、リポジトリの保守管理者と連絡を取って共同作業を行うにはどうすれば一番良いかを指示します。 リポジトリのセキュリティ ポリシーは、リポジトリの [Security] タブから確認できます。
- リポジトリのメイン ページから、 [セキュリティ] をクリックします。
- 左側のサイド バーの [レポート] で、 [ポリシー] をクリックします。
- [Start setup] (セットアップの開始) をクリックします。
- プロジェクトのサポートされているバージョンに関する情報と、脆弱性の報告方法に関する情報を追加してください。
詳しくは、「リポジトリへのセキュリティ ポリシーの追加」をご覧ください。
次のステップ
セキュリティの機能からのアラートを表示及び管理して、コード中の依存関係と脆弱性に対処できます。 詳しくは、「Dependabot アラートの表示と更新」、「依存関係の更新に関するPull Requestを管理する」、「リポジトリのコード スキャンのアラートの評価」、「シークレット スキャン アラートの管理」を参照してください。
また、GitHub のツールを使用して、セキュリティ アラートへの応答を監査することもできます。 詳しくは、「セキュリティ アラートの監査」をご覧ください。
パブリック リポジトリにセキュリティの脆弱性があるなら、セキュリティ アドバイザリを作成して非公開で議論し、脆弱性を修正できます。 詳細については、「リポジトリ セキュリティ アドバイザリについて」および「リポジトリ セキュリティ アドバイザリの作成」を参照してください。
GitHub Actionsを使用する場合、GitHubのセキュリティ機能を使用して、ワークフローのセキュリティを強化できます。 詳しくは、「セキュリティで保護された使用に関するリファレンス」をご覧ください。