Quick start guide¶
The use of package is very simple. This document is a brief explanation.
Installation¶
Install the package is so easy. Simple type this: x .. code-block:: bash
> sudo pip install openvas-to-report
Note
Remember that you need Python 3!!
Generate Excel¶
To generate an Excel File you need to export the OpenVAS results as a XML format. If you can’t a report by hand, you can find one in example
folder.
Then, you need to use openvas_to_document
tool:
> openvas_to_document -i my_openvas_report.xml -o generated_excel.xlsx
For further information go to the Openvas to report manual.
Filter results¶
If you want to filter the XML OpenVAS file, deleting some targets for example, and generate a new XML document without this information, you can user openvas_cutter
First we create a file with the targets that we want to remove.
> echo 10.0.1.1 > remove_targets.txt
Now launch the script:
> openvas_cutter -i my_openvas_report.xml -o my_openvas_report_filtered.xml --exclude-hosts remove_targets.txt
For further information go to the Openvas cutter manual.
As a library¶
You also can use the library in your won code, importing as a usual lib. After install de library, using bellow instructions, you only must do:
from openvas_to_report.api import Config, convert
c = Config(input_files=["input_file.xml"], output_file="results.xlsx")
convert(c)
For further information go to the Openvas as library manual.