client: remove cache TODO

Don't cache entry lookups by ID.

Although it would be easy enough to use Cache.{Read,Write}Entries to
store a single entry under its ID, detecting stale entries would add
complexity. The index is used for module staleness, but there is no
similar place to store last-modified times for individual entries.

Until we know that users will repeatedly request entries by ID, it's
not worth the effort to cache them.

Change-Id: I74b8b7fff50e99fa8670c1c3b63018be44638675
Reviewed-on: https://go-review.googlesource.com/c/vulndb/+/357036
Trust: Jonathan Amsterdam <jba@google.com>
Run-TryBot: Jonathan Amsterdam <jba@google.com>
TryBot-Result: Go Bot <gobot@golang.org>
Reviewed-by: Julie Qiu <julie@golang.org>
1 file changed
tree: 79282ea90c86b44346acda08ed467a7584f0e109
  1. client/
  2. cmd/
  3. deploy/
  4. internal/
  5. osv/
  6. reports/
  7. AUTHORS
  8. CONTRIBUTING.md
  9. CONTRIBUTORS
  10. LICENSE
  11. PATENTS
  12. README.md
  13. all.bash
  14. format.md
  15. go.mod
  16. go.sum
  17. lint_test.go
  18. new-vuln.sh
  19. template
  20. 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.

  • 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/dbdiff provides a tool for comparing two different versions of the vulnerability database
  • cmd/gendb provides a tool for converting YAML reports into JSON database
  • cmd/linter provides a tool for linting individual reports
  • cmd/report2cve provides a tool for converting YAML 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.