Google Git
Sign in
go / vulndb / 36ac6840de0393c84d89514d647e032136328e5b
commit36ac6840de0393c84d89514d647e032136328e5b[log] [tgz]
authorZvonimir Pavlinovic <zpavlinovic@google.com>Tue Aug 24 18:51:17 2021 -0700
committerZvonimir Pavlinovic <zpavlinovic@google.com>Thu Sep 02 23:05:46 2021 +0000
tree669e3af74ed6a19602e78eae249925aa70699f36
parent7d681823527bb924320e2a358a68eb4168f53ccf [diff]
vulndb/client: make Get accept a single module path

Current signature of Get accepts a list of module paths. A single
argument is a cleaner solution not affecting client library usability.
This CL makes the switch and cleans up unit testing.

Change-Id: Ic67fa02e0372f19882b75c47ced8f1a2a9b3a233
Reviewed-on: https://go-review.googlesource.com/c/vulndb/+/344870
Run-TryBot: Zvonimir Pavlinovic <zpavlinovic@google.com>
TryBot-Result: Go Bot <gobot@golang.org>
Reviewed-by: Roland Shoemaker <roland@golang.org>
Reviewed-by: kokoro <noreply+kokoro@google.com>
Trust: Zvonimir Pavlinovic <zpavlinovic@google.com>
2 files changed
tree: 669e3af74ed6a19602e78eae249925aa70699f36
  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.