Skip to content

Commit d105b22

Browse files
committed
fedcode-next: Documentation on how to use the new curation feature
Signed-off-by: ziad hany <ziadhany2016@gmail.com>
1 parent 0679677 commit d105b22

21 files changed

Lines changed: 145 additions & 0 deletions
Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
.. _advisory-package-curation:
2+
3+
Advisory Package Curation
4+
=========================
5+
6+
Follow these steps to curate the packages associated with an advisory:
7+
8+
.. image:: images/advisory-package-curation.png
9+
10+
1. Click the alias you want to curate (for example, **CVE-2024-6221**).
11+
12+
2. Select the appropriate package version status.
13+
14+
- For each package version, click **Select value** and choose one of the following statuses:
15+
16+
- **AFFECTED**
17+
- **FIXED**
18+
- **UNAFFECTED**
19+
20+
.. image:: images/package_select_value.png
21+
22+
.. note::
23+
24+
Click **Select value** multiple times to cycle through the available statuses (**AFFECTED**, **FIXED**, and **UNAFFECTED**).
25+
26+
Alternatively, if one of the suggested advisories is correct, click **Pick this** to automatically apply the recommended package version information.
27+
28+
.. image:: images/package_pick_this.png
29+
30+
3. Click **Next item**. If the button is available, repeat steps 2–3 for each remaining package.
31+
32+
.. image:: images/package_next_item.png
33+
34+
4. After reviewing all packages, click **Submit** to save and complete the package curation.
35+
36+
.. image:: images/package_submit.png
Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
.. _advisory-severity-curation:
2+
3+
Advisory Severity Curation
4+
==========================
5+
6+
Follow these steps to curate the severity for advisories:
7+
8+
.. image:: images/advisory-severity-curation.png
9+
10+
1. Click the alias you want to curate (for example, ``GHSA-5rfv-66g4-jr8h``)
11+
12+
2. For each key, select the appropriate vector value from the available options
13+
14+
.. image:: images/severity_select_value.png
15+
16+
Alternatively, select the correct advisory severity
17+
18+
.. image:: images/severity_pick_this.png
19+
20+
3. Click **Next item**, if the button is available, and repeat steps 2–3 for each remaining severity
21+
22+
4. Once you have curated all advisories, click **Submit**
23+
24+
.. image:: images/severity_submit-button.png

docs/source/advisory-todos.rst

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
.. _advisory_todos:
2+
3+
Advisory Todos
4+
==============
5+
6+
Overview
7+
----------
8+
The Advisory To-Dos queue contains security advisories that require manual review to improve the quality and
9+
accuracy of vulnerablecode data
10+
11+
Supported Advisory Curation Types
12+
------------------------------------
13+
14+
Our advisory curation process supports enriching and validating the following vulnerability advisory metadata, depending on the information available from trusted sources:
15+
16+
* **Package Curation**: See :ref:`advisory-package-curation`.
17+
18+
- Advisories with conflicting **fixed** package versions.
19+
- Advisories with conflicting **affected** package versions.
20+
- Advisories with conflicting **affected** and **fixed** package versions.
21+
- *(Not currently supported)* Advisories missing affected package versions.
22+
- *(Not currently supported)* Advisories missing fixed package versions.
23+
- *(Not currently supported)* Advisories missing both affected and fixed package versions.
24+
25+
* **Severity Curation**: Advisories with conflicting CVSS vectors (CVSSv3, CVSSv3.1, CVSSv4, ...) . See :ref:`advisory-severity-curation`.
26+
* **Weakness Curation**: Advisories with conflicting Common Weakness Enumeration (CWE) identifiers. See :ref:`advisory-weakness-curation`.
27+
* **Summary Curation**: *(Not currently supported).*
28+
29+
Each curation guide provides detailed instructions for reviewing advisories in the corresponding curation queue.
30+
31+
Accessing the Advisory To-Dos Queue
32+
-----------------------------------
33+
34+
1. Go to https://public.vulnerablecode.io/.
35+
36+
2. Click **Advisory To-Dos**.
37+
38+
.. image:: images/advisory-to-dos-click.png
39+
40+
3. Click **Continue**.
41+
42+
.. image:: images/continue-button.png
43+
44+
4. Search for advisories by **alias**, or filter the list by **Resolved** status or **issue type**.
45+
46+
.. image:: images/advisory-to-do-dashbaord.png
Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
.. _advisory-weakness-curation:
2+
3+
Advisory Weakness Curation
4+
===========================
5+
6+
Follow these steps to curate the `Common Weakness Enumeration (CWE) <https://cwe.mitre.org/>`_ associated with an advisories:
7+
8+
.. image:: images/advisory-weakness-curation.png
9+
10+
1. Click the Alias you want to curate, for example, ``CVE-2022-24512``.
11+
12+
2. Select the appropriate CWE status (APPLICABLE or NOT APPLICABLE) for the selected CWE ID.
13+
14+
.. image:: images/weakness_select_value.png
15+
16+
OR, you can select the CWE status from an advisory that you trust to provide accurate data.
17+
18+
.. image:: images/weakness_pick_this.png
19+
20+
3. Click **Submit**.
21+
22+
.. image:: images/weakness_submit.png
328 KB
Loading
360 KB
Loading
129 KB
Loading
42 KB
Loading
285 KB
Loading
15.4 KB
Loading

0 commit comments

Comments
 (0)