This document explains how we handle vulnerability issue triage in the x/vulndb issue tracker.
All vulnerabilities in the Go vulnerability database are currently stored as a YAML file in the reports/ directory.
Each vulnerability is given an ID with the format GO-YYYY-NNNN.
For a detailed explanation of the report format, see doc/format.md.
Any issue must be in one of the following states. Maintainers of the Go vulndb move issues from one state to another. The intent behind these explicit states is to describe the (minimum) next steps required to bring the issue to resolution.
Issues are intended to move between these states:
+-------------+ | | via CL +------------>| NeedsReport +----------+ | | | | | +-------------+ | +---------+--------+ v | | Closed New ---->|NeedsInvestigation| | (optional) | +------------+ ^ +----------+-------+ | | | | | NotGoVuln +-----------+ +----------->| | +------------+
The issue has been filed by the vulndb worker
The issue will have the title:
x/vulndb: potential Go vuln in <module/package>: <CVE ID>
To transition from this state, someone must:
NotGoVulnlabel should be applied at the time the issue is closed for tracking purposes (such as data on how to improve the automatic triager).
If an issue is labeled with
NeedsReport and is not assigned to anyone, you can add a new report to the database by following these steps:
Assign the issue to yourself.
Clone the x/vulndb repository:
git clone https://go.googlesource.com/vulndb
You will need a GitHub access token with scope
export VULN_GITHUB_ACCESS_TOKEN=<Github access token>
go run ./cmd/vulnreport create <GitHub issue number>. vulnreport will download the github.com/CVEProject/cvelist repository and create a YAML report template for the CVE at the specified GitHub issue number.
Edit the report file template.
go run ./cmd/vulnreport commit <report file>. This will lint the report and commit it with a standard commit message.
When adding a vulnerability report about the standard library, ensure that the links section follows this format:
- links: - pr: - https://go.dev/cl/<#> - commit: - https://go.googlesource.com/<repo>/+/<commit> - context: - https://go.dev/issue/<#> - golang-announce@ email
You can find these links in the golang-announce@ email for the security release fixing this vulnerability.
PR: The PR will be a go.dev/cl/<#> link, found as a gopherbot comment on the issue for the vulnerability.
Commit: The commit is a go.googlesource.com link, which can be found on the CL page (see screenshot).
Issue: The issue will be listed in the golang-announce@ email.
Occasionally, we will receive new information about a Go vulnerability and want to update the existing report.
In that case, reopen the issue for the report to discuss the change, rather than create a new issue.