Cyberdefense/VulnWhisperer
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Austin Taylor
2017-12-28 23:39:31 -05:00
committed by GitHub
parent 34638bcf42
commit 24417cd1bb
1 changed files with 8 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@ -5,7 +5,7 @@
<p align="center" style="width:400px"><img src="https://github.com/austin-taylor/vulnwhisperer/blob/master/docs/source/vulnwhisp_dashboard.jpg" style="width:400px"></p> <p align="center" style="width:400px"><img src="https://github.com/austin-taylor/vulnwhisperer/blob/master/docs/source/vulnwhisp_dashboard.jpg" style="width:400px"></p>
VulnWhisperer is a vulnerability report aggregator for nessus (more scanners to come). VulnWhisperer will pull all the reports VulnWhisperer is a vulnerability report aggregator. VulnWhisperer will pull all the reports
and create a file with a unique filename which is then fed into logstash. Logstash extracts data from the filename and tags all of the information inside the report (see logstash_vulnwhisp.conf file). Data is then shipped to elasticsearch to be indexed. and create a file with a unique filename which is then fed into logstash. Logstash extracts data from the filename and tags all of the information inside the report (see logstash_vulnwhisp.conf file). Data is then shipped to elasticsearch to be indexed.
@ -14,7 +14,7 @@ Requirements
#### ####
* ElasticStack * ElasticStack
* Python 2.7 * Python 2.7
* Vulnerability Scanner - (Nessus) * Vulnerability Scanner
* Optional: Message broker such as Kafka or RabbitMQ * Optional: Message broker such as Kafka or RabbitMQ
Currently Supports Currently Supports
@ -23,6 +23,7 @@ Currently Supports
* Elasticsearch 2.x * Elasticsearch 2.x
* Python 2.7 * Python 2.7
* Nessus * Nessus
* . Qualys - Web Application Scanner
Setup Setup
@ -56,11 +57,15 @@ There are a few configuration steps to setting up VulnWhisperer:
Run Run
----- -----
To run, fill out the configuration file with your vulnerability scanner settings. Then you can execute from the command line.
```python ```python
vuln_whisperer -c configs/example.ini vuln_whisperer -c configs/example.ini -s nessus
or
vuln_whisperer -c configs/example.ini -s qualys
``` ```
Next you'll need to import the visualizations into Kibana and setup your logstash config. A more thorough README is underway with setup instructions.
_For windows, you may need to type the full path of the binary in vulnWhisperer located in the bin directory._ _For windows, you may need to type the full path of the binary in vulnWhisperer located in the bin directory._