|
1 |
| -This repository contains a handful of prototypes for the Go vulnerability database, |
2 |
| -as well as a initial set of vulnerability reports. Some of these packages can probably |
3 |
| -be coalesced, but for now are easier to work on in a more segmented fashion. |
| 1 | +# The Go Vulnerability Database `golang.org/x/vulndb` |
| 2 | + |
| 3 | +This repository is a prototype of the Go Vulnerability Database. |
| 4 | +Read [the Draft Design](https://golang.org/design/draft-vulndb). |
| 5 | + |
| 6 | +Neither the code, nor the data, nor the existence of this repository is to be |
| 7 | +considered stable until an approved proposal. |
| 8 | + |
| 9 | +**Important**: vulnerability entries in this repository are represented in an |
| 10 | +internal, unstable format that can and will change without notice. The database |
| 11 | +will also be available in an interoperable, stable JSON format soon. |
| 12 | + |
| 13 | +## Packages |
| 14 | + |
| 15 | +Some of these packages can probably be coalesced, but for now are easier to work |
| 16 | +on in a more segmented fashion. |
4 | 17 |
|
5 |
| -* `reports` contains TOML security reports, the format is described in `format.md` |
6 | 18 | * `report` provides a package for parsing and linting TOML reports
|
7 |
| -* `osv` provides a package for generating OSV-style JSON vulnerability entries from a `report.Report` |
8 |
| -* `client` contains a client for accesing HTTP/fs based vulnerability databases, as well as a minimal caching implementation |
| 19 | +* `osv` provides a package for generating OSV-style JSON vulnerability entries |
| 20 | + from a `report.Report` |
| 21 | +* `client` contains a client for accessing HTTP/fs based vulnerability |
| 22 | + databases, as well as a minimal caching implementation |
9 | 23 | * `cmd/gendb` provides a tool for converting TOML reports into JSON database
|
10 | 24 | * `cmd/genhtml` provides a tool for converting TOML reports into a HTML website
|
11 | 25 | * `cmd/linter` provides a tool for linting individual reports
|
12 |
| -* `cmd/report2cve` provides a tool for converting TOML reports into JSON CVEs |
| 26 | +* `cmd/report2cve` provides a tool for converting TOML reports into JSON CVEs |
| 27 | + |
| 28 | +## Contributing |
| 29 | + |
| 30 | +To report a new *public* vulnerability, [open an |
| 31 | +issue](https://github.com/golang/vulndb/issues/new) or send a PR. Please read |
| 32 | +the [Contribution Guidelines](https://golang.org/doc/contribute.html) before |
| 33 | +sending patches. |
| 34 | + |
| 35 | +Unless otherwise noted, the Go source files are distributed under |
| 36 | +the BSD-style license found in the LICENSE file. |
| 37 | + |
| 38 | +The database contents in `reports/` are distributed under the terms of the |
| 39 | +[CC-BY 4.0](https://creativecommons.org/licenses/by/4.0/) license. |
0 commit comments