The Go Vulnerability Database

Clone this repo:

Branches

  1. e0c00fa osv: document package by Roland Shoemaker · 3 weeks ago master
  2. 820ef4a client: document package by Roland Shoemaker · 3 weeks ago
  3. 24a7677 reports: more consistent description tone by Roland Shoemaker · 3 weeks ago
  4. 68e64dc README: add provisional GCS bucket link by Filippo Valsorda · 3 weeks ago
  5. aca001a all: go mod tidy by Filippo Valsorda · 3 weeks ago

The Go Vulnerability Database golang.org/x/vulndb

This repository is a prototype of the Go Vulnerability Database. Read the Draft Design.

Neither the code, nor the data, nor the existence of this repository is to be considered stable until an approved proposal.

Important: vulnerability entries in this repository are represented in an internal, unstable format that can and will change without notice.

Consuming database entries

Database clients must not rely on the contents of this repository. Instead, they can access the tree of JSON entries rooted at

https://storage.googleapis.com/go-vulndb/

An index.json file maps package names to last modified timestamps. For each package name, a NAME.json file contains a list of vulnerability entries.

Note that this path and format are provisional and likely to change until an approved proposal.

Packages

Some of these packages can probably be coalesced, but for now are easier to work on in a more segmented fashion.

  • report provides a package for parsing and linting TOML reports
  • osv provides a package for generating OSV-style JSON vulnerability entries from a report.Report
  • client contains a client for accessing HTTP/fs based vulnerability databases, as well as a minimal caching implementation
  • cmd/gendb provides a tool for converting TOML reports into JSON database
  • cmd/genhtml provides a tool for converting TOML reports into a HTML website
  • cmd/linter provides a tool for linting individual reports
  • cmd/report2cve provides a tool for converting TOML reports into JSON CVEs

License

Unless otherwise noted, the Go source files are distributed under the BSD-style license found in the LICENSE file.

Database entries available at https://storage.googleapis.com/go-vulndb/ are distributed under the terms of the CC-BY 4.0 license.