From 543986009efe6d6f5f259748938e9d5318dacd61 Mon Sep 17 00:00:00 2001 From: Pidgey Date: Wed, 2 Dec 2015 18:57:47 +0100 Subject: [PATCH] Update README.md --- README.md | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index f2ff283..b733fb8 100644 --- a/README.md +++ b/README.md @@ -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.