1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77
|
# SPDX-FileCopyrightText: 2024 Martin Boller
#
# SPDX-License-Identifier: GPL-3.0-or-later
import sys
from argparse import Namespace
from pathlib import Path
from gvm.protocols.gmp import Gmp
from lxml import etree
def check_args(args):
len_args = len(args.script) - 1
if len_args < 1:
message = """
This script requests the given report and exports it as a xml
file locally. It requires one parameters after the script name.
1. <report_id> -- ID of the report
Optional a file name to save the xml in.
Example:
$ gvm-script --gmp-username name --gmp-password pass \
ssh --hostname <gsm> scripts/export-xml-report.gmp.py <report_id> <xml_file>
"""
print(message)
sys.exit()
def main(gmp: Gmp, args: Namespace) -> None:
# check if report id and xml filename are provided to the script
# argv[0] contains the script name
check_args(args)
report_id = args.argv[1]
if len(args.argv) == 3:
xml_filename = args.argv[2] + ".xml"
else:
xml_filename = args.argv[1] + ".xml"
xml_report_format_id = "5057e5cc-b825-11e4-9d0e-28d24461215b"
response = gmp.get_report(
report_id=report_id,
report_format_id=xml_report_format_id,
ignore_pagination=True,
details=True,
)
report_element = response.find("report")
# get the full content of the report element as bytestring
content = etree.tostring(report_element.find("report"))
if not content:
print(
"Requested report is empty. Either the report does not contain any"
" results or the necessary tools for creating the report are "
"not installed.",
file=sys.stderr,
)
sys.exit(1)
# decode content
dcontent = content.decode("utf-8")
# write to file and support ~ in filename path
xml_path = Path(xml_filename).expanduser()
xml_path.write_text(dcontent)
print("Done. xml created: " + str(xml_path))
if __name__ == "__gmp__":
main(gmp, args)
|