|author||Julie Qiu <email@example.com>||Fri Oct 15 16:24:29 2021 -0400|
|committer||Julie Qiu <firstname.lastname@example.org>||Mon Oct 18 20:46:20 2021 +0000|
all.bash: add initial setup An all.bash file is added, which runs these go linters on the vulndb repo: * go vet: examines Go source code and reports suspicious constructs * staticcheck: runs static analysis on Go source code * unparam: finds unused params in Go source code * misspell: checks for commonly misspelled English words Ideally this would run in CI, but for now this is meant to be used during development to quickly find bugs. Change-Id: Ic6005f64a8f180852ae0b8556d26341dcf2e6603 Reviewed-on: https://go-review.googlesource.com/c/vulndb/+/356349 Trust: Julie Qiu <email@example.com> Run-TryBot: Julie Qiu <firstname.lastname@example.org> TryBot-Result: Go Bot <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.