Google Git
Sign in
go / vuln / 34203db3aa9d3fdb52a45b857064f0d10049e3ac
commit34203db3aa9d3fdb52a45b857064f0d10049e3ac[log] [tgz]
authorJulie Qiu <julie@golang.org>Mon Oct 11 20:41:51 2021 -0400
committerJulie Qiu <julie@golang.org>Fri Oct 15 20:08:32 2021 +0000
treec29c2f91e144264113dc3861f1b3096179a27702
parentbc3226dbb7d639288fc796a8ae45017a72052831 [diff]
internal: document structs in cve.go

Also rearrange the file in order of struct hierachy.

Change-Id: If2d05f2bbc9f6d5a267be7a15780f5a0c4597033
Reviewed-on: https://go-review.googlesource.com/c/vulndb/+/355194
Trust: Julie Qiu <julie@golang.org>
Run-TryBot: Julie Qiu <julie@golang.org>
TryBot-Result: Go Bot <gobot@golang.org>
Reviewed-by: Roland Shoemaker <roland@golang.org>
1 file changed
tree: c29c2f91e144264113dc3861f1b3096179a27702
  1. client/
  2. cmd/
  3. deploy/
  4. internal/
  5. osv/
  6. reports/
  7. AUTHORS
  8. CONTRIBUTING.md
  9. CONTRIBUTORS
  10. format.md
  11. go.mod
  12. go.sum
  13. LICENSE
  14. lint_test.go
  15. new-vuln.sh
  16. PATENTS
  17. README.md
  18. template
  19. triaged-cve-list
README.md

The Go Vulnerability Database golang.org/x/vulndb

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.

Consuming database entries

Database clients must not rely on the contents of this repository. Instead, they can access the tree of JSON entries rooted at

https://storage.googleapis.com/go-vulndb/

An 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.

Packages

Some of these packages can probably be coalesced, but for now are easier to work on in a more segmented fashion.

  • osv provides a package for generating OSV-style JSON vulnerability entries from a report.Report
  • client contains a client for accessing HTTP/fs based vulnerability databases, as well as a minimal caching implementation
  • cmd/dbdiff provides a tool for comparing two different versions of the vulnerability database
  • cmd/gendb provides a tool for converting YAML reports into JSON database
  • cmd/linter provides a tool for linting individual reports
  • cmd/report2cve provides a tool for converting YAML reports into JSON CVEs

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.