Skip to main content

Privately reporting a security vulnerability

Some public repositories configure security advisories so that anyone can report security vulnerabilities directly and privately to the maintainers.

メモ: 脆弱性のプライベート レポートは現在、ベータ版であり、変更される場合があります。

パブリック リポジトリの所有者と管理者は、リポジトリでプライベート脆弱性レポートを有効にすることができます。 詳しくは、「リポジトリのプライベート脆弱性レポートの構成」をご覧ください。

About privately reporting a security vulnerability

Security researchers often feel responsible for alerting users to a vulnerability that could be exploited. If there are no clear instuctions about contacting maintainers of the repository containing the vulnerability, security researchers may have no other choice but to post about the vulnerability on social media, send direct messages to the maintainer, or even create public issues. This situation can potentially lead to a public disclosure of the vulnerability details.

Private vulnerability reporting makes it easy for security researchers to report vulnerabilities directly to repository maintainer using a simple form.

For security researchers, the benefits of using private vulnerability reporting are:

  • Less frustration, and less time spent trying to figure out how to contact the maintainer.
  • A smoother process for disclosing and discussing vulnerability details.
  • The opportunity to discuss vulnerability details privately with repository maintainer.

Note: If the repository doesn't have private vulnerabiliy reporting enabled, you need to initiate the reporting process by following the instructions in the security policy for the repository, or create an issue asking the maintainers for a preferred security contact. For more information, see "About coordinated disclosure of security vulnerabilities."

Privately reporting a security vulnerability

Security researchers can privately report a security vulnerability to repository maintainers.

  1. On GitHub.com, navigate to the main page of the repository.

  2. リポジトリ名の下にある [ セキュリティ] をクリックします。 [セキュリティ] タブ

  3. 左側のサイドバーの [レポート] で、 [アドバイザリ] をクリックします。 [セキュリティ アドバイザリ] タブ

  4. Click Report a vulnerability to open the advisory form.

    Screenshot showing the "Report a vulnerability" button

  5. Fill in the advisory details form.

    Tip: In this form, only the title and description are mandatory. (In the general draft security advisory form, which the repository maintainer initiates, specifying the ecosystem is also required.) However, we recommend security researchers provide as much information as possible on the form so that the maintainers can make an informed decision about the submitted report. You can adopt the template used by our security researchers from the GitHub Security Lab, which is available on the github/securitylab repository."

    For more information about the fields available and guidance on filling in the form, see "Creating a repository security advisory" and "Best practices for writing repository security advisories."

  6. At the bottom of the form, click Submit report. GitHub will display a message letting you know that maintainers have been notified and that you have a pending credit for this security advisory.

    Screenshot showing the "Submit report" button

    Tip: When the report is submitted, GitHub automatically adds the reporter of the vulnerability as a collaborator and as a credited user on the proposed advisory.

  7. Optionally, click Start a temporary private fork if you want to start to fix the issue. Note that only the repository maintainer can merge that private fork.

    Screenshot showing the "Start a temporary fork" button

The next steps depend on the action taken by the repository maintainer. For more information, see "Managing privately reported security vulnerabilities."