Advisories for NATS
This repository hosts public advisories, typically security advisories, related to the NATS project.
It is intended to be accessed via https://advisories.nats.io
To limit the risk of accidental early disclosure, most forms of public comment are disabled on the repo.
Adding an Advisory
Expect people to have notifications enabled for this repository, so that avoiding an index for a new page does not help keep something secret.
- Add the text file to the
- Edit the
index.mdfile with appropriate description
- Commit and push on the main branch
- See deployment progress at: https://github.com/nats-io/advisories/deployments/activity_log?environment=github-pages
Getting a CVE assignment
In future, let's use GitHub's ability to request a CVE as part of drafting an advisory. Getting a CVE through the formerly used process has become not expeditious.
CVEs are typically requested from MITRE as the CNA of last resort for open
source projects: https://cveform.mitre.org/ Fill out enough details to get the number; be accurate, or withhold data, as
appropriate. At this first stage, I usually make sure to classify the type of
vulnerability and the affected version numbers, but not much more. After the CVE has been published, we can update the text with another use of
We create GitHub Security Advisories for any project on GitHub, to aid with ecosystem notifications. Cross-reference the GHSA advisory and the CVE in this repository. See any existing advisory for examples.
Publicising the Advisory
- The push to the GitHub repo, on any branch, will alert people who have watches set up, so from that moment on the public clock is ticking.
- Send a copy to the
oss-securitymailing-list, which is the main current announcement mailing-list for open source software security issues; https://oss-security.openwall.org/wiki/mailing-lists/oss-security / https://www.openwall.com/lists/oss-security/
- Create a GitHub security advisory; this will help downstream users get
automatic notifications if they depend upon the affected software.
The repository's "Security" tab, "Security advisories" section.
You can draft an advisory ahead of time; publishing the advisory is almost irreversible.
- For Go vulnerabilities, file an issue to update the Go Vulnerability Database using this ticket-opening shortcut, as documented in the announcement blog-post.
- Notify Slack in various places: natsio #general, gophers #nats
- If really disastrous, consider getting a tweet tweeted from the official account.
- Update the official CVE registration details.
bundle installto install the dependencies.
bundle exec jekyll serveto serve a local site preview.
See the pages-themes GitHub repo for further details about customizing the template, layout, and CSS.