Google Git
Sign in
go / vuln / 64f6208a73cede780c0276e26da46d00955f9368
commit64f6208a73cede780c0276e26da46d00955f9368[log] [tgz]
authorJulie Qiu <julie@golang.org>Mon Oct 18 16:53:40 2021 -0400
committerJulie Qiu <julie@golang.org>Thu Oct 28 18:47:08 2021 +0000
tree821ee2fb2be89542ba716259c8b112cd1162fceb
parent269162fb643eb7582e2526777f68369fa1990c2f [diff]
internal/derrors: add an internal errors package

An internal errors package is added that implements some simple common
error semantics.

derrors.Wrap allows errors to be annotated with a defer statement. It is
applied to the following packages / commands:

- cmd/cvetriage
- cmd/dbdiff
- cmd/report2cve
- internal

This pattern will be applied to other packages in later CLs.

Change-Id: I9976647c64f13a8a1cb9cfdfc6af940dfc8b9510
Reviewed-on: https://go-review.googlesource.com/c/vulndb/+/356613
Trust: Julie Qiu <julie@golang.org>
Run-TryBot: Julie Qiu <julie@golang.org>
TryBot-Result: Go Bot <gobot@golang.org>
Reviewed-by: Jonathan Amsterdam <jba@google.com>
5 files changed
tree: 821ee2fb2be89542ba716259c8b112cd1162fceb
  1. client/
  2. cmd/
  3. deploy/
  4. internal/
  5. osv/
  6. reports/
  7. all.bash
  8. AUTHORS
  9. CONTRIBUTING.md
  10. CONTRIBUTORS
  11. format.md
  12. go.mod
  13. go.sum
  14. LICENSE
  15. lint_test.go
  16. new-vuln.sh
  17. PATENTS
  18. README.md
  19. template
  20. 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.