|author||Julie Qiu <firstname.lastname@example.org>||Tue Oct 19 16:12:53 2021 -0400|
|committer||Julie Qiu <email@example.com>||Tue Oct 26 20:05:50 2021 +0000|
internal/report: document CVEMeta vs CVE Document when report.CVEMeta vs report.CVE and report.Description should be used. Change-Id: Icf2d75b4701d8c7aad84e0d4d3e826adce0a2402 Reviewed-on: https://go-review.googlesource.com/c/vulndb/+/357030 Trust: Julie Qiu <firstname.lastname@example.org> Run-TryBot: 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.