Google Git
Sign in
go / vuln / 4ce6bdd19e607a85fb6a168b9fc5d1ba9692637f
commit4ce6bdd19e607a85fb6a168b9fc5d1ba9692637f[log] [tgz]
authorJonathan Amsterdam <jba@google.com>Tue Dec 14 06:38:21 2021 -0500
committerJonathan Amsterdam <jba@google.com>Wed Dec 15 08:24:21 2021 +0000
tree29368805ba24e05089c5381a8e427c98d3188f48
parent0be10a336e28cdfa01f9b3dfde9b94dd2acf5b47 [diff]
vuln: reports can have multiple CVEs

A report can be associated with multiple CVEs.

The osv.Entry type already accommodated this, but the report.Report
type did not, so added Report.CVEs.

For backwards compatibility and easy of writing reports, leave
Report.CVE. The linter checks that at most one of CVE and CVEs is
populated.

Along the way, correct minor issues with style and doc.

Change-Id: Ib28aa4f022f9e01c2cfdf17a1d69dcac6a71b8dc
Reviewed-on: https://go-review.googlesource.com/c/vuln/+/371596
Trust: Jonathan Amsterdam <jba@google.com>
Run-TryBot: Jonathan Amsterdam <jba@google.com>
TryBot-Result: Gopher Robot <gobot@golang.org>
Reviewed-by: Julie Qiu <julie@golang.org>
6 files changed
tree: 29368805ba24e05089c5381a8e427c98d3188f48
  1. client/
  2. cmd/
  3. devtools/
  4. internal/
  5. osv/
  6. terraform/
  7. vlint/
  8. .gitignore
  9. all_test.go
  10. AUTHORS
  11. checks.bash
  12. CONTRIBUTING.md
  13. CONTRIBUTORS
  14. go.mod
  15. go.sum
  16. LICENSE
  17. PATENTS
  18. README.md
  19. tools_test.go
  20. triaged-cve-list
README.md

Go Vulnerability Database

Go Reference

This repository contains code for hosting the Go Vulnerability Database. The actual reports can be found at x/vulndb.

Neither the code, nor the data, nor the existence of this repository is to be considered stable. See the Draft Design for details on this project.

Accessing the database

The Go vulnerability database is rooted at https://storage.googleapis.com/go-vulndb and provides data as JSON. We recommend using client.Client to read data from the Go vulnerability database.

Do not rely on the contents of the x/vulndb repository. The YAML files in that repository are maintained using an internal format that is subject to change without warning.

The endpoints the table below are supported. For each path:

  • $base is the path portion of a Go vulnerability database URL (https://storage.googleapis.com/go-vulndb).
  • $module is a module path
  • $vuln is a Go vulnerabilitiy ID (for example, GO-2021-1234)
PathDescription
$base/index.jsonList of module paths in the database mapped to its last modified timestamp (link).
$base/$module.jsonList of vulnerability entries for that module (example).
$base/ID/index.jsonList of all the vulnerability entries in the database
$base/ID/$vuln.jsonAn individual Go vulnerability report

Note that these paths 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.

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.