summaryrefslogtreecommitdiff
path: root/README.md
blob: 9d00524a878cceb2ce8e1d2dd4b5564456a96b05 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
# cve-checker
VyOS security vulnerability checker is a utility for obtaining information about possible vulnerabilities

# Modules that require an API key:
vulners
- (To get the API key, you need to register on the website https://vulners.com/ and generate new key here https://vulners.com/userinfo)

# Install and dependencies:
- Python 3.7+
- MongoDB 4.2+

# Usage:
<p>[command][option1][option2]</p>
<p>--help</p>
<p>--init-db - The command is required when you first run the utility</p>
<p>--update-vulners-db - [date1, date2] - get updates of vulnerabilities database from date1 to date2 (only for trial, professional, etc. Vulners.com accounts) </p>
<p>--update-db - get updates of vulnerabilities database (Upgrade based on free databases) </p>
<p>--update-info - get information about the number of new CVEs, missing in the database. Checking is carried out on the basis of MitreCVE db.</p>
<p>--start [name of file with packages information, (This is the output of the command: apt list --installed)
                           Code name of Debian version on which VyOS is based (for example: Stretch, Buster)] </p>
<p><b>For example:</b></p>
<em><p>cve.checker.py --help</p>
<p>cve.checker.py --init-db</p>
<p>cve.checker.py --update-vulners-db 01.01.2020 30.09.2020</p>
<p>cve.checker.py --update-db</p>
<p>cve.checker.py --update-info</p>
<p>cve.checker.py --start /tmp/packages.txt Buster</p></em>