|author||Julie Qiu <email@example.com>||Mon Nov 01 15:12:13 2021 -0400|
|committer||Julie Qiu <firstname.lastname@example.org>||Tue Nov 09 03:03:31 2021 +0000|
README.md: updated The contents of the README.md are updated to reflect the current project. Change-Id: I8461f50c4468a0f2b206a93a36e88d09b5e5f871 Reviewed-on: https://go-review.googlesource.com/c/vuln/+/360440 Trust: Julie Qiu <email@example.com> Reviewed-by: Jonathan Amsterdam <firstname.lastname@example.org>
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.
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/index.json||List of module paths in the database mapped to its last modified timestamp (link).|
|$base/$module.json||List of vulnerability entries for that module (example).|
|$base/ID/index.json||List of all the vulnerability entries in the database|
|$base/ID/$vuln.json||An individual Go vulnerability report|
Note that these paths and format are provisional and likely to change until an approved proposal.
Some of these packages can probably be coalesced, but for now are easier to work on in a more segmented fashion.
osvprovides a package for generating OSV-style JSON vulnerability entries from a
clientcontains a client for accessing HTTP/fs based vulnerability databases, as well as a minimal caching implementation
cmd/dbdiffprovides a tool for comparing two different versions of the vulnerability database
cmd/gendbprovides a tool for converting YAML reports into JSON database
cmd/linterprovides a tool for linting individual reports
cmd/report2cveprovides a tool for converting YAML reports into JSON CVEs
Unless otherwise noted, the Go source files are distributed under the BSD-style license found in the LICENSE file.