Skip to content

Commit 80f70eb

Browse files
committed
Move docs to better markdown structure.
- fix typo in filename
1 parent d68ef27 commit 80f70eb

2 files changed

Lines changed: 53 additions & 52 deletions

File tree

docs/exteral-data-improvements.md

Lines changed: 0 additions & 52 deletions
This file was deleted.

docs/external-data-improvements.md

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
# Information on Helping To Improve External Data
2+
3+
Remember that these requests are outside the scope of the ruby-advisory-db repo.
4+
5+
Here are the different sources of information this repo usually uses and how to request a change if needed.
6+
7+
## GENERAL
8+
9+
- Missing CVE number (also just "reserved" CVE with no details)
10+
- Google CVE number, check cve.org and nvd.nist.gov web sites
11+
- Missing GHSA number
12+
- Google GHSA number, check [GHSA](https://github.com/advisories) web site.
13+
- Missing patch release
14+
- See [repo](https://github.com/rubysec/ruby-advisory-db) README on policy.
15+
- Have only project-specific data (announcement, blog, CHANGELOG, Release notes) about advisory
16+
- Google for more information. Try to contact developer privately.
17+
- To exclude a duplicate or disputed advisories, send them to @jasnow to add them to his ignored-dup-list.file.
18+
19+
## GEMS
20+
21+
- PR: To change a specific **GHSA rubygems-related** advisory, go to [GHSA](https://github.com/advisories) and search for the specific advisory. Scroll down to the bottom of web page and click on `See something to contribute?` link. This will open a page where you can edit the advisory and create
22+
a GHSA PR.
23+
24+
- EXAMPLE:
25+
- https://github.com/github/advisory-database/pull/7717 (open)
26+
- https://github.com/github/advisory-database/issues/7296 (open)
27+
- https://github.com/github/advisory-database/issues/1796 (gave up)
28+
29+
- To create a **new GHSA rubygems-advisory**, go to [HERE](https://docs.github.com/en/code-security/how-tos/report-and-fix-vulnerabilities/fix-reported-vulnerabilities/creating-a-repository-security-advisory) and follow their instructions.
30+
31+
- To change something on the **https://nvd.nist.gov/vuln/detail** web site, currently not known but you can read more at [HERE](https://nvd.nist.gov/general/cve-process).
32+
33+
- To change something on **https://www.cve.org** as Non-CNA, got [HERE](https://www.cve.org/ReportRequest/ReportRequestForNonCNAs) and follows their directions.
34+
35+
- To change something with **osvdb** advisory, the Open Sourced Vulnerability Database (OSVDB) was permanently shut down in 2016 and is no longer active or hosted online. Try to see if there is a GHSA or CVE reference that that vulnerability.
36+
37+
## RUBIES (ruby, jruby, mruby, rubinius/rbx, etc)
38+
39+
- For specific GHSA ruby-related unreviewed advisory change, go to https://github.com/advisories?query=type%3Aunreviewed
40+
and search for the specific advisory. Scroll down to the bottom of web page and click on "See something to contribute?" link. This will open a page where you can edit the advisory and create a GHSA PR.
41+
42+
- For changes on Ruby web site, go https://github.com/ruby/www.ruby-lang.org and follow:
43+
- [Quick Fixes](https://github.com/ruby/www.ruby-lang.org/blob/master/README.md#quick-fixes)
44+
- [Making Changes](https://github.com/ruby/www.ruby-lang.org/blob/master/README.md#making-changes)
45+
46+
- To add additional GHSA `ecosystem`, such for `RubyNotGem` advisories, create GHSA and osv-schema issues and/or PRs. See examples below:
47+
- EXAMPLES
48+
- https://github.com/ossf/osv-schema/pull/515 (assigned to @another-rex/gave up)
49+
- https://github.com/ossf/osv-schema/issues/123 (gave up)
50+
- https://github.com/github/advisory-database/issues/1796 (gave up)
51+
- https://github.com/github/advisory-database/issues/6676 (gave up)
52+
53+
Feel free to **suggest more scenarios to add or better words/etc to improve existing scenarios.**

0 commit comments

Comments
 (0)