Google Git
Sign in
go / vulndb / c856ba870e929e5c7913d9148f063a6b299c8434
commitc856ba870e929e5c7913d9148f063a6b299c8434[log] [tgz]
authorRoland Shoemaker <roland@golang.org>Thu May 20 09:58:22 2021 -0700
committerRoland Shoemaker <roland@golang.org>Fri May 21 02:20:14 2021 +0000
tree18c82b5d192bf53de5bda62ebc907d804e90050f
parente0c00fae09e687ec6febda47ae3bc7552fc7b988 [diff]
report,osv,client: update schema to current state

Match the current state of https://tinyurl.com/vuln-json, also fix a
minor bug in deploy-db.sh.

Change-Id: Ib6c225637cb538ef263b7bf182d30e36e76a43e3
Reviewed-on: https://go-review.googlesource.com/c/vulndb/+/321509
Trust: Roland Shoemaker <roland@golang.org>
Run-TryBot: Roland Shoemaker <roland@golang.org>
Reviewed-by: Filippo Valsorda <filippo@golang.org>
5 files changed
tree: 18c82b5d192bf53de5bda62ebc907d804e90050f
  1. client/
  2. cmd/
  3. osv/
  4. report/
  5. reports/
  6. AUTHORS
  7. CONTRIBUTING.md
  8. CONTRIBUTORS
  9. deploy-db.sh
  10. format.md
  11. go.mod
  12. go.sum
  13. LICENSE
  14. new-vuln.sh
  15. PATENTS
  16. README.md
  17. template
  18. triaged-cve-list
README.md

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.