Skip to content

Commit 988b93d

Browse files
committed
all: add licensing boilerplate and update README
Change-Id: I79bcdc1d868fccbb778ccdef23a4ad7389cf5bfe Reviewed-on: https://team-review.git.corp.google.com/c/golang/vulndb/+/1054183 Reviewed-by: Filippo Valsorda <[email protected]>
1 parent 91bf12f commit 988b93d

File tree

5 files changed

+89
-7
lines changed

5 files changed

+89
-7
lines changed

AUTHORS

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# This source code refers to The Go Authors for copyright purposes.
2+
# The master list of authors is in the main Go distribution,
3+
# visible at https://tip.golang.org/AUTHORS.

CONTRIBUTORS

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# This source code was written by the Go contributors.
2+
# The master list of contributors is in the main Go distribution,
3+
# visible at https://tip.golang.org/CONTRIBUTORS.

LICENSE

+27
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
Copyright (c) 2009 The Go Authors. All rights reserved.
2+
3+
Redistribution and use in source and binary forms, with or without
4+
modification, are permitted provided that the following conditions are
5+
met:
6+
7+
* Redistributions of source code must retain the above copyright
8+
notice, this list of conditions and the following disclaimer.
9+
* Redistributions in binary form must reproduce the above
10+
copyright notice, this list of conditions and the following disclaimer
11+
in the documentation and/or other materials provided with the
12+
distribution.
13+
* Neither the name of Google Inc. nor the names of its
14+
contributors may be used to endorse or promote products derived from
15+
this software without specific prior written permission.
16+
17+
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18+
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19+
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
20+
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
21+
OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
22+
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
23+
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24+
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25+
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26+
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
27+
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

PATENTS

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
Additional IP Rights Grant (Patents)
2+
3+
"This implementation" means the copyrightable works distributed by
4+
Google as part of the Go project.
5+
6+
Google hereby grants to You a perpetual, worldwide, non-exclusive,
7+
no-charge, royalty-free, irrevocable (except as stated in this section)
8+
patent license to make, have made, use, offer to sell, sell, import,
9+
transfer and otherwise run, modify and propagate the contents of this
10+
implementation of Go, where such license applies only to those patent
11+
claims, both currently owned or controlled by Google and acquired in
12+
the future, licensable by Google that are necessarily infringed by this
13+
implementation of Go. This grant does not include claims that would be
14+
infringed only as a consequence of further modification of this
15+
implementation. If you or your agent or exclusive licensee institute or
16+
order or agree to the institution of patent litigation against any
17+
entity (including a cross-claim or counterclaim in a lawsuit) alleging
18+
that this implementation of Go or any code incorporated within this
19+
implementation of Go constitutes direct or contributory patent
20+
infringement, or inducement of patent infringement, then any patent
21+
rights granted to you under this License for this implementation of Go
22+
shall terminate as of the date such litigation is filed.

README.md

+34-7
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,39 @@
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.
417

5-
* `reports` contains TOML security reports, the format is described in `format.md`
618
* `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
923
* `cmd/gendb` provides a tool for converting TOML reports into JSON database
1024
* `cmd/genhtml` provides a tool for converting TOML reports into a HTML website
1125
* `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

Comments
 (0)