|author||Jonathan Amsterdam <email@example.com>||Fri Oct 15 09:53:59 2021 -0400|
|committer||Jonathan Amsterdam <firstname.lastname@example.org>||Tue Oct 19 18:11:09 2021 +0000|
client: rename Get to GetByModule Now that there is a GetByID method, rename "Get" to something that clarifies the difference between it and GetByID. Change-Id: Id24abb9ef78e14e17a7f4910685151e31cd05cc6 Reviewed-on: https://go-review.googlesource.com/c/vulndb/+/356149 Trust: Jonathan Amsterdam <email@example.com> Run-TryBot: Jonathan Amsterdam <firstname.lastname@example.org> Reviewed-by: Julie Qiu <email@example.com> Reviewed-by: Roland Shoemaker <firstname.lastname@example.org>
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.
Database clients must not rely on the contents of this repository. Instead, they can access the tree of JSON entries rooted at
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.
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.