Command line usageΒΆ
# When working from the Git repo
python3 -m openvasreporting -i *.xml [-i ...] [-c config.yml] [-o openvas_report] [-f xlsx] [-l none] [-t "openvasreporting/src/openvas-template.docx"] [-T vulnerability] [-n included_networks] [-N excluded-networks] [-r included-regex] [-R excluded-regex] [-e included-cve] [-E excluded-cve]
# When using the pip package
openvasreporting -i *.xml [-i ...] [-c config.yml] [-o openvas_report] [-f xlsx] [-l none] [-t "openvasreporting/src/openvas-template.docx"] [-T vulnerability] [-n included_networks] [-N excluded-networks] [-r included-regex] [-R excluded-regex] [-e included-cve] [-E excluded-cve]
- -i, --input
- MandatorySelects the OpenVAS XML report file(s) to be used as input.Accepts one or more inputs, including wildcards
- -o, --output
- OptionalName of the output file, without extension.Defaults to: openvas_report
- -c, --config-file
- OptionalPath to a .yml file containing the configuration (format, level, type, filters)If this option is used all other options (but input and output files) will be ignoredDefaults to: None
- -f, --format
- OptionalType of output file.Valid values are: xlsx, docx, csvDefaults to: xlsx
- -l, --level
- OptionalMinimal severity level of finding before it's included in the report.Valid values are: c(ritical), h(igh), m(edium), l(low), n(one)Defaults to: none
- -t, --template
- Optional, only used with '-f docx'Template document for docx export. Document must contain formatting for styles used in export.Valid values are: path to a docx fileDefaults to: openvasreporting/src/openvas-template.docx
- -T, --report-type
- OptionalSelects if will list hosts by vulnerability (v) or vulnerabilities by host (h)Valid values are: v, h, vulnerabiity, hostDefaults to: vulnerability
- -e, --network-include
- Optionalpath to a file containing a list of ips, ipcidrs or ipaddrs (one per line) thatwill be included in the reportDefaults to: all hosts with appropriate level will be included
- -E, --network-exclude
- Optionalpath to a file containing a list of ips, ipcidrs or ipaddrs (one per line) thatwill be excluded from the reportDefaults to: no excluded hosts
- -r, --regex-include
- Optionalpath to a file containing a list of regex expressions that will be matched againstthe name of the vulnerability field to be filtered into the reportDefaults to: all vulnerabilities will be included
- -R, --regex-exclude
- Optionalpath to a file containing a list of regex expressions that will be matched againstthe name of the vulnerability field to be filtered out of the reportDefaults to: no excluded vulnerabilities
- -e, --cve-include
- Optionalpath to a file containing a list of CVEs (format CVEYYYY-nnn...) that will befiltered into the reportDefaults to: all vulnerabilities with -l level will be included
- -C, --cve-exclude
- Optionalpath to a file containing a list of CVEs (format CVEYYYY-nnn...) that will befiltered out of the reportDefaults to: no excluded hosts
Todo
[Feature] Export to other formats (PDF, [proper] CSV)