Skip to content

Instantly share code, notes, and snippets.

@JLLeitschuh
Last active July 14, 2020 16:55
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save JLLeitschuh/66ead318480b43168190389c4660a70d to your computer and use it in GitHub Desktop.
Save JLLeitschuh/66ead318480b43168190389c4660a70d to your computer and use it in GitHub Desktop.
An explanation of how to work with GitHub security advisories.

GitHub Security Advisories

If this is your first time using GitHub Security Advisories, please allow me to guide you through how they work.

Advisories are Private

As of September 17th, 2019, when advisories are published, the entire discussion within the advisory will not be made public. Any information you want to provide to the public should be included in the advisory body.

Updating an Advisory

The UX for this is kinda bad on GitHub's behalf. In order to put the information in the advisory, you must use the form button.

Show Form Button

Requesting a CVE Number

I would recommend requesting a Common Vulnerabilities & Exposures (CVE) number from a CVE Numbering Authority (CNA) before publishing your advisory. A CVE number is a common number that is used to track/disclose a vulnerability publicly.

The following CNA's may be relevant to your vulnerability:

Publishing an Advisory

Once a CVE number has been received, add it to the advisory, take one last proofreading pass, and click the 'Publish Advisory' button.

Publish Advisory Button

Updatiing an Advisory After Publication

As of September 17th, 2019, this is currently only possible by reaching out to the GitHub support staff and asking them to update your advisory for you. In my opinion this won't scale and is a pretty bad user experience given that almost everything else on GitHub can be updated after you post it. The GitHub team has confirmed that they are aware of this issue, hopefully this won't be a limitation much longer.

@JLLeitschuh
Copy link
Author

So glad this is no longer needed. The UI has improved drastically.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment