Google Git
Sign in
go / vulndb / a74bfd4ac7ebef92b045337ef020e067a56073c0
commita74bfd4ac7ebef92b045337ef020e067a56073c0[log] [tgz]
authorRoland Shoemaker <roland@golang.org>Thu Aug 05 13:40:35 2021 -0700
committerRoland Shoemaker <roland@golang.org>Fri Sep 03 20:43:07 2021 +0000
treec32df5e6b38bed0b6f1a740714e71c8914b044a4
parent36ac6840de0393c84d89514d647e032136328e5b [diff]
osv: use new multi-package format

An implementation of the specification change proposed by
https://github.com/ossf/osv-schema/pull/1. The significant change here
is that instead of generating multiple entries for reports with
multiple packages (in the additional_packages section), we instead
generate a single entry that covers all of the packages, and write the
same entry for each module path.

Change-Id: Ia9d8e0a82081ab7f5becd20c6adf976f4d6966db
Reviewed-on: https://go-review.googlesource.com/c/vulndb/+/340210
Reviewed-by: kokoro <noreply+kokoro@google.com>
Reviewed-by: Filippo Valsorda <filippo@golang.org>
Trust: Roland Shoemaker <roland@golang.org>
Run-TryBot: Roland Shoemaker <roland@golang.org>
TryBot-Result: Go Bot <gobot@golang.org>
Vulndb-Deploy: Roland Shoemaker <bracewell@google.com>
3 files changed
tree: c32df5e6b38bed0b6f1a740714e71c8914b044a4
  1. client/
  2. cmd/
  3. deploy/
  4. osv/
  5. report/
  6. reports/
  7. AUTHORS
  8. CONTRIBUTING.md
  9. CONTRIBUTORS
  10. format.md
  11. go.mod
  12. go.sum
  13. LICENSE
  14. lint_test.go
  15. new-vuln.sh
  16. PATENTS
  17. README.md
  18. template
  19. 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 module paths to last modified timestamps (link).

For each module, a NAME.json file contains a list of vulnerability entries (example).

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.