internal/worker: add server routes

Add /update to update the DB from the cvelist repo head and decide
which CVEs need issues.

Add /issues to file issues.

Add /update-and-issues to do both. This is the endpoint that the Cloud
Scheduler will hit.

Change-Id: Ifccb4e7cc040e87a8290b6111182180d22df6040
Reviewed-on: https://go-review.googlesource.com/c/vuln/+/370754
Trust: Jonathan Amsterdam <jba@google.com>
Run-TryBot: Jonathan Amsterdam <jba@google.com>
Reviewed-by: Julie Qiu <julie@golang.org>
5 files changed
tree: 115f6e24d429f87f43d08ac794f723e8a44e2ba7
  1. client/
  2. cmd/
  3. devtools/
  4. internal/
  5. osv/
  6. terraform/
  7. vlint/
  8. .gitignore
  9. all.bash
  10. AUTHORS
  11. CONTRIBUTING.md
  12. CONTRIBUTORS
  13. go.mod
  14. go.sum
  15. LICENSE
  16. PATENTS
  17. README.md
  18. triaged-cve-list
README.md

Go Vulnerability Database

Go Reference

This repository contains code for hosting the Go Vulnerability Database. The actual reports can be found at x/vulndb.

Neither the code, nor the data, nor the existence of this repository is to be considered stable. See the Draft Design for details on this project.

Accessing the database

The Go vulnerability database is rooted at https://storage.googleapis.com/go-vulndb and provides data as JSON. We recommend using client.Client to read data from the Go vulnerability database.

Do not rely on the contents of the x/vulndb repository. The YAML files in that repository are maintained using an internal format that is subject to change without warning.

The endpoints the table below are supported. For each path:

  • $base is the path portion of a Go vulnerability database URL (https://storage.googleapis.com/go-vulndb).
  • $module is a module path
  • $vuln is a Go vulnerabilitiy ID (for example, GO-2021-1234)
PathDescription
$base/index.jsonList of module paths in the database mapped to its last modified timestamp (link).
$base/$module.jsonList of vulnerability entries for that module (example).
$base/ID/index.jsonList of all the vulnerability entries in the database
$base/ID/$vuln.jsonAn individual Go vulnerability report

Note that these paths 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.

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.