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
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
|
# SPDX-FileCopyrightText: 2024 Martin Boller
#
# SPDX-License-Identifier: GPL-3.0-or-later
import sys
from argparse import ArgumentParser, Namespace, RawTextHelpFormatter
from gvm.protocols.gmp import Gmp
from gvmtools.helper import Table
HELP_TEXT = (
"This script list reports with the status "
"defined on the commandline. Status can be: \n"
"Requested, Queued, Interrupted, Running, or Done \n"
"Note: Case matters. E.g. - done - won't work, but - Done - will"
)
def check_args(args):
len_args = len(args.script) - 1
if len_args != 1:
message = """
This script lists all reports depending on status.
One parameter after the script name is required.
1. Status -- Either \"All\", \"Requested\", \"Queued\", \"Interrupted\", \"Running\", \"StopRequested\", \"Stopped\", or \"Done\"
Example:
$ gvm-script --gmp-username name --gmp-password pass \
socket list-reports.gmp.py Done \n
"""
print(message)
sys.exit()
def parse_args(args: Namespace) -> Namespace: # pylint: disable=unused-argument
"""Parsing args ..."""
parser = ArgumentParser(
prefix_chars="+",
add_help=False,
formatter_class=RawTextHelpFormatter,
description=HELP_TEXT,
)
parser.add_argument(
"+h",
"++help",
action="help",
help="Show this help message and exit.",
)
parser.add_argument(
"status_cmd",
type=str,
help=(
'Status: "All", "Queued", "Requested", "Interrupted", "Running", "Stop Requested", "Stopped" or "Done"'
),
)
script_args, _ = parser.parse_known_args(args)
return script_args
def list_reports(
gmp: Gmp,
status: str,
):
str_status = status
if status.upper() == "ALL":
status = "All"
elif status.upper() == "REQUESTED":
str_status = "Requested"
elif status.upper() == "INTERRUPTED":
str_status = "Interrupted"
elif status.upper() == "QUEUED":
str_status = "Queued"
elif status.upper()[:6] == "STOPRE":
str_status = "Stop Requested"
elif status.upper()[:6] == "STOP R":
str_status = "Stop Requested"
elif status.upper() == "DONE":
str_status = "Done"
elif status.upper() == "RUNNING":
str_status = "Running"
elif status.upper() == "STOPPED":
str_status = "Stopped"
else:
str_status = "All"
print("Reports with status: " + str_status + "\n")
if str_status == "All":
response_xml = gmp.get_reports(
ignore_pagination=True, details=True, filter_string="rows=-1"
)
else:
response_xml = gmp.get_reports(
ignore_pagination=True,
details=True,
filter_string="status="
+ str_status
+ " and sort-reverse=name and rows=-1",
)
reports_xml = response_xml.xpath("report")
heading = [
"#",
"Id",
"Creation Time",
"Modification Time",
"Task Name",
"Status",
"Progress",
]
rows = []
numberRows = 0
for report in reports_xml:
# Count number of reports
numberRows = numberRows + 1
# Cast/convert to text to show in list
rowNumber = str(numberRows)
creation_time = "".join(report.xpath("creation_time/text()"))
# report_name = "".join(report.xpath("name/text()")) # Report name is the same as Creation Time
report_id = report.get("id")
report_task = "".join(report.xpath("task/name/text()"))
mod_time = "".join(report.xpath("modification_time/text()"))
report_status = "".join(report.xpath("report/scan_run_status/text()"))
report_progress = (
"".join(report.xpath("report/task/progress/text()")) + "%"
)
rows.append(
[
rowNumber,
report_id,
creation_time,
mod_time,
report_task,
report_status,
report_progress,
]
)
print(Table(heading=heading, rows=rows))
def main(gmp: Gmp, args: Namespace) -> None:
# pylint: disable=unused-argument
if args.script:
args = args.script[1:]
parsed_args = parse_args(args=args)
print("Listing reports.\n")
list_reports(gmp, parsed_args.status_cmd)
if __name__ == "__gmp__":
main(gmp, args)
|
