Skip to content

Commit d9f2633

Browse files
committed
docs: adding database schema
1 parent 2bb8032 commit d9f2633

File tree

2 files changed

+9
-0
lines changed

2 files changed

+9
-0
lines changed

doc/MANUAL.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@
55
- [Installing](#installing)
66
- [Fixing Known Issues / What should I do if it finds something?](#fixing-known-issues--what-should-i-do-if-it-finds-something)
77
- [Limitations](#limitations)
8+
- [Architecture](#architecture)
9+
- [Database Structure](#database-structure)
810
- [Optional Arguments](#optional-arguments)
911
- [-e EXCLUDE, --exclude EXCLUDE](#-e-exclude---exclude-exclude)
1012
- [-h, --help](#-h---help)
@@ -320,6 +322,13 @@ The tool does not guarantee that all vulnerabilities are reported as the tool on
320322
Whilst some validation checks are performed on the data within the vulnerability database, the tool is unable to assert the quality of the data or correct any
321323
discrepancies if the data is incomplete or inconsistent. This may result, for example, in some vulnerability reports where the severity is reported as UNKNOWN.
322324

325+
## Architecture
326+
327+
### Database Structure
328+
329+
The CVE Binary Tool database comprises three tables: cve_severity, cve_range, and cve_exploited. The cve_range and cve_severity tables are connected. The cve_range has a foreign key referencing the cve_number and data_source in the cve_severity table. The cve_severity table holds information about the severity of vulnerabilities, with the cve_number serving as the primary key. The cve_range table is linked to cve_severity via the cve_number and data_source columns, establishing a relationship between vulnerability severity and affected product ranges. The cve_exploited table tracks exploited vulnerabilities, utilizing the cve_number as the primary key. This database structure enables effective management and analysis of CVE-related data, facilitating identifying and assessing vulnerabilities and their associated exploit instances.
330+
331+
![database structure of CVE Binary Tool](images/cve-bin-tool-database.png)
323332

324333
## Optional Arguments
325334

doc/images/cve-bin-tool-database.png

54.2 KB
Loading

0 commit comments

Comments
 (0)