Skip to content
OpenVAS Reporting: Convert OpenVAS XML report files to reports
Branch: master
Clone or download
Pull request Compare This branch is 139 commits ahead of cr0hn:master.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs
openvasreporting Correct URL, some code optimalisations Apr 8, 2019
.gitignore Ignore dist folder Nov 5, 2018
LICENSE Add license Aug 27, 2018
README.md
__init__.py Correct URL, some code optimalisations Apr 8, 2019
requirements.txt Merge branch 'master' of github.com:TheGroundZero/openvasreporting Oct 10, 2018
setup.py

README.md

OpenVAS Reporting:

GitHub version License Docs Known Vulnerabilities codecov Requirements Status PyPI - Version PyPI - Format

A tool to convert OpenVAS XML into reports.

Report example screenshot

Read the full documentation at https://openvas-reporting.stijncrevits.be

I forked OpenVAS2Report since it didn't manage to convert all reports I threw at it and because I wanted to learn how to use Python for working with XML and creating Excel files.
Also, OpenVAS mixes their own threat levels with the CVSS scoring, the latter of which I prefer to use in my reports.

Looking for a fix and providing an actual fix through a pull request would have been too much work, so I chose to fork the repo and try my own thing.
I reorganised some of the files, removed some functionality and added some extra, and rewrote some functions.

At this moment in time, the script only output .xlsx documents in one format, this may (not) change in the future.

Requirements

Installation

# install requirements
apt(-get) install python3 python3-pip # Debian, Ubuntu
yum -y install python3 python3-pip    # CentOS
dnf install python3 python3-pip       # Fedora
pip3 install -r requirements.txt
# clone repo
git clone git@github.com:TheGroundZero/openvas_to_report.git

Alternatively, you can install the package through the Python package installer 'pip'.

# Install pip
apt(-get) install python3 python3-pip # Debian, Ubuntu
yum -y install python3 python3-pip    # CentOS
dnf install python3 python3-pip       # Fedora
# Install the package
pip install OpenVAS-Reporting

Usage

# When working from the Git repo
python3 -m openvasreporting -i [OpenVAS xml file(s)] [-o [Output file]] [-f [Output format]] [-l [minimal threat level (n, l, m, h, c)]] [-f [docx template]]
# When using the pip package
OpenVAS-Reporting -i [OpenVAS xml file(s)] [-o [Output file]] [-f [Output format]] [-l [minimal threat level (n, l, m, h, c)]] [-f [docx template]]

Parameters

Short param Long param Description Required Default value
-i --input Input file(s) YES n/a
-o --output Output filename No openvas_report
-f --format Output format No xlsx
-l --level Minimal level No n
-t --template Docx template No openvasreporting/src/openvas-template.docx

Examples

Create Excel report from 1 OpenVAS XML report using default settings

python3 -m openvasreporting -i openvasreport.xml -f xlsx

Create Excel report from multiple OpenVAS reports using default settings

# wildcard select
python3 -m openvasreporting -i *.xml -f xlsx
# selective
python3 -m openvasreporting -i openvasreport1.xml -i openvasreport2.xml -f xlsx

Create Word report from multiple OpenVAS reports, reporting only threat level high and up, use custom template

python3 -m openvasreporting -i *.xml -o docxreport -f docx -l h -t "/home/user/myOpenvasTemplate.docx"

Result

The final report (in Excel format) will then look something like this:

Report example screenshot - Summary Report example screenshot - ToC Report example screenshot - Vuln desc

Worksheets are sorted according to CVSS score and are colored according to the vulnerability level.

Ideas

Some of the ideas I still have for future functionality:

  • list vulnerabilities per host
  • make pip installer
  • filter by host (scope/exclude) as in OpenVAS2Report
  • export to other formats (CSV, PDF)
  • select threat levels individually (e.g. none and low; but not med, high and crit)
You can’t perform that action at this time.