cmd/report2cve,cmd/vulnreport: merge

cmd/report2cve and cmd/vulnreport are merged into a single tool for
handling the YAML reports.

Change-Id: If242f24b0b1d48a96c90f9065b91f5922bed46e6
Reviewed-on: https://go-review.googlesource.com/c/vuln/+/373003
Trust: Julie Qiu <julie@golang.org>
Run-TryBot: Julie Qiu <julie@golang.org>
TryBot-Result: Gopher Robot <gobot@golang.org>
Reviewed-by: Jonathan Amsterdam <jba@google.com>
2 files changed
tree: 95bb40f6df28eb683446e320ccfa47fd315a8c9b
  1. client/
  2. devtools/
  3. internal/
  4. osv/
  5. srv/
  6. terraform/
  7. .gitignore
  8. AUTHORS
  9. CONTRIBUTING.md
  10. CONTRIBUTORS
  11. LICENSE
  12. PATENTS
  13. README.md
  14. all_test.go
  15. checks.bash
  16. go.mod
  17. go.sum
  18. tools_test.go
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.