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
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
|
# SPDX-FileCopyrightText: 2024 Greenbone AG
#
# SPDX-License-Identifier: GPL-3.0-or-later
from typing import Optional, Union
from gvm.errors import InvalidArgument, RequiredArgument
from gvm.protocols.core import Request
from gvm.utils import to_bool
from gvm.xml import XmlCommand, XmlError
from .._entity_id import EntityID
from ..v224._report_formats import ReportFormatType
class Reports:
@classmethod
def delete_report(cls, report_id: EntityID) -> Request:
"""Deletes an existing report
Args:
report_id: UUID of the report to be deleted.
"""
if not report_id:
raise RequiredArgument(
function=cls.delete_report.__name__, argument="report_id"
)
cmd = XmlCommand("delete_report")
cmd.set_attribute("report_id", str(report_id))
return cmd
@classmethod
def get_report(
cls,
report_id: EntityID,
*,
filter_string: Optional[str] = None,
filter_id: Optional[str] = None,
delta_report_id: Optional[EntityID] = None,
report_format_id: Optional[Union[str, ReportFormatType]] = None,
report_config_id: Optional[str] = None,
ignore_pagination: Optional[bool] = None,
details: Optional[bool] = True,
) -> Request:
"""Request a single report
Args:
report_id: UUID of an existing report
filter_string: Filter term to use to filter results in the report
filter_id: UUID of filter to use to filter results in the report
delta_report_id: UUID of an existing report to compare report to.
report_format_id: UUID of report format to use
or ReportFormatType (enum)
report_config_id: UUID of report format config to use
ignore_pagination: Whether to ignore the filter terms "first" and
"rows".
details: Request additional report information details
defaults to True
"""
cmd = XmlCommand("get_reports")
if not report_id:
raise RequiredArgument(
function=cls.get_report.__name__, argument="report_id"
)
cmd.set_attribute("report_id", str(report_id))
cmd.set_attribute("usage_type", "scan")
cmd.add_filter(filter_string, filter_id)
if delta_report_id:
cmd.set_attribute("delta_report_id", str(delta_report_id))
if report_format_id:
cmd.set_attribute("format_id", str(report_format_id))
if report_config_id:
cmd.set_attribute("config_id", str(report_config_id))
if ignore_pagination is not None:
cmd.set_attribute("ignore_pagination", to_bool(ignore_pagination))
cmd.set_attribute("details", to_bool(details))
return cmd
@staticmethod
def get_reports(
*,
filter_string: Optional[str] = None,
filter_id: Optional[EntityID] = None,
note_details: Optional[bool] = None,
override_details: Optional[bool] = None,
ignore_pagination: Optional[bool] = None,
details: Optional[bool] = None,
) -> Request:
"""Request a list of reports
Args:
filter_string: Filter term to use for the query
filter_id: UUID of an existing filter to use for the query
note_details: If notes are included, whether to include note details
override_details: If overrides are included, whether to include
override details
ignore_pagination: Whether to ignore the filter terms "first" and
"rows".
details: Whether to exclude results
"""
cmd = XmlCommand("get_reports")
cmd.set_attribute("usage_type", "scan")
if filter_string:
cmd.set_attribute("report_filter", filter_string)
if filter_id:
cmd.set_attribute("report_filt_id", str(filter_id))
if note_details is not None:
cmd.set_attribute("note_details", to_bool(note_details))
if override_details is not None:
cmd.set_attribute("override_details", to_bool(override_details))
if details is not None:
cmd.set_attribute("details", to_bool(details))
if ignore_pagination is not None:
cmd.set_attribute("ignore_pagination", to_bool(ignore_pagination))
return cmd
@classmethod
def import_report(
cls,
report: str,
task_id: EntityID,
*,
in_assets: Optional[bool] = None,
) -> Request:
"""Import a Report from XML
Args:
report: Report XML as string to import. This XML must contain
a :code:`<report>` root element.
task_id: UUID of task to import report to
in_asset: Whether to create or update assets using the report
"""
if not report:
raise RequiredArgument(
function=cls.import_report.__name__, argument="report"
)
cmd = XmlCommand("create_report")
if not task_id:
raise RequiredArgument(
function=cls.import_report.__name__, argument="task_id"
)
cmd.add_element("task", attrs={"id": str(task_id)})
if in_assets is not None:
cmd.add_element("in_assets", to_bool(in_assets))
try:
cmd.append_xml_str(report)
except XmlError as e:
raise InvalidArgument(
f"Invalid xml passed as report to import_report {e}"
) from None
return cmd
|
