Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
PidgeyL committed Dec 2, 2015
1 parent 2f8bf71 commit 5439860
Showing 1 changed file with 8 additions and 3 deletions.
11 changes: 8 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,18 +30,23 @@ CVE-Scan needs some aditional packages to work. Install them using:
```pip3 install -r requirements.txt```

## Usage:
To use CVE-Scan, first run an nmap scan on a system. You can modify the parameters however you want, however, you'd want to include Service Detection and OS detection. Below, you can find a default nmap scan that will output to an xml file.
To use CVE-Scan, first run an nmap scan on a system. You can modify the
parameters however you want, however, you'd want to include Service Detection
and OS detection. Below, you can find a default nmap scan that will output to
an xml file.

```nmap -A -O 192.168.0.1 -oX output.xml```

CVE-Scan is composed of 3 major functions:
* **converter.py** - Converts the nmap xml to the CVE-Scan json format
* **analyzer.py** - Analyses either an nmap xml or a CVE-Scan json and queries CVE-Search to obtain vulnerability information
* **analyzer.py** - Analyses either an nmap xml or a CVE-Scan json and
queries CVE-Search to obtain vulnerability information
* **visualizer.py** - Visualizes the results of analyzer.py

and **Nmap2CVE-Search.py**, which does all of the above in 1 go.

You can either run ```python3 Nmap2CVE-Search.py output.xml``` or
You can either run ```python3 Nmap2CVE-Search.py output.xml``` to
enhance and visualize the report or
```python3 analyzer.py -x output.xml enhanced.json```, to create the
enhanced report, followed by ```python3 visualizer.py enhanced.json```
to visualize the report (default webserver on localhost:5050.
Expand Down

0 comments on commit 5439860

Please sign in to comment.