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
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
|
# SPDX-FileCopyrightText: 2025 Greenbone AG
#
# SPDX-License-Identifier: GPL-3.0-or-later
"""
Greenbone Management Protocol (GMP) version 22.6
"""
from typing import Optional, Sequence, Union
from .._protocol import T
from ._gmp225 import GMPv225
from .requests.v226 import (
AuditReports,
EntityID,
Filters,
FilterType,
ReportConfigParameter,
ReportConfigs,
ReportFormatType,
Reports,
ResourceNames,
ResourceType,
)
class GMPv226(GMPv225[T]):
"""
A class implementing the Greenbone Management Protocol (GMP) version 22.6
Example:
.. code-block:: python
from gvm.protocols.gmp import GMPv226 as GMP
with GMP(connection) as gmp:
resp = gmp.get_tasks()
"""
@staticmethod
def get_protocol_version() -> tuple[int, int]:
return (22, 6)
def get_resource_names(
self,
resource_type: ResourceType, # type: ignore[override]
*,
filter_string: Optional[str] = None,
) -> T:
"""Request a list of resource names and IDs
Arguments:
resource_type: Type must be either ALERT, CERT_BUND_ADV,
CONFIG, CPE, CREDENTIAL, CVE, DFN_CERT_ADV, FILTER,
GROUP, HOST, NOTE, NVT, OS, OVERRIDE, PERMISSION,
PORT_LIST, REPORT_FORMAT, REPORT, REPORT_CONFIG, RESULT, ROLE,
SCANNER, SCHEDULE, TARGET, TASK, TLS_CERTIFICATE
or USER
filter_string: Filter term to use for the query
"""
return self._send_request_and_transform_response(
ResourceNames.get_resource_names(
resource_type, filter_string=filter_string
)
)
def get_resource_name(
self,
resource_id: str,
resource_type: ResourceType, # type: ignore[override]
) -> T:
"""Request a single resource name
Arguments:
resource_id: ID of an existing resource
resource_type: Type must be either ALERT, CERT_BUND_ADV,
CONFIG, CPE, CREDENTIAL, CVE, DFN_CERT_ADV, FILTER,
GROUP, HOST, NOTE, NVT, OS, OVERRIDE, PERMISSION,
PORT_LIST, REPORT_FORMAT, REPORT, REPORT_CONFIG, RESULT, ROLE,
SCANNER, SCHEDULE, TARGET, TASK, TLS_CERTIFICATE
or USER
"""
return self._send_request_and_transform_response(
ResourceNames.get_resource_name(resource_id, resource_type)
)
def delete_report(self, report_id: EntityID) -> T:
"""Deletes an existing scan report
Args:
report_id: UUID of the report to be deleted.
"""
return self._send_request_and_transform_response(
Reports.delete_report(report_id)
)
def get_report(
self,
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,
) -> T:
"""Request a single scan 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
"""
return self._send_request_and_transform_response(
Reports.get_report(
report_id,
filter_string=filter_string,
filter_id=filter_id,
delta_report_id=delta_report_id,
report_format_id=report_format_id,
report_config_id=report_config_id,
ignore_pagination=ignore_pagination,
details=details,
)
)
def get_reports(
self,
*,
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,
) -> T:
"""Request a list of scan 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
"""
return self._send_request_and_transform_response(
Reports.get_reports(
filter_string=filter_string,
filter_id=filter_id,
note_details=note_details,
override_details=override_details,
ignore_pagination=ignore_pagination,
details=details,
)
)
def import_report(
self,
report: str,
task_id: EntityID,
*,
in_assets: Optional[bool] = None,
) -> T:
"""Import a scan 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
"""
return self._send_request_and_transform_response(
Reports.import_report(report, task_id, in_assets=in_assets)
)
def delete_audit_report(self, report_id: EntityID) -> T:
"""Deletes an existing audit report
Args:
report_id: UUID of the report to be deleted.
"""
return self._send_request_and_transform_response(
AuditReports.delete_report(report_id)
)
def get_audit_report(
self,
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,
ignore_pagination: Optional[bool] = None,
details: Optional[bool] = True,
) -> T:
"""Request a single audit report
Args:
report_id: UUID of an existing audit 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)
ignore_pagination: Whether to ignore the filter terms "first" and
"rows".
details: Request additional report information details
defaults to True
"""
return self._send_request_and_transform_response(
AuditReports.get_report(
report_id,
filter_string=filter_string,
filter_id=filter_id,
delta_report_id=delta_report_id,
report_format_id=report_format_id,
ignore_pagination=ignore_pagination,
details=details,
)
)
def get_audit_reports(
self,
*,
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,
) -> T:
"""Request a list of audit 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
"""
return self._send_request_and_transform_response(
AuditReports.get_reports(
filter_string=filter_string,
filter_id=filter_id,
note_details=note_details,
override_details=override_details,
ignore_pagination=ignore_pagination,
details=details,
)
)
def create_filter(
self,
name: str,
*,
filter_type: Optional[FilterType] = None, # type: ignore[override]
comment: Optional[str] = None,
term: Optional[str] = None,
) -> T:
"""Create a new filter
Args:
name: Name of the new filter
filter_type: Filter for entity type
comment: Comment for the filter
term: Filter term e.g. 'name=foo'
"""
# override create_filter because of the different FilterType enum
# this avoids warnings with type checkers
return self._send_request_and_transform_response(
Filters.create_filter(
name, filter_type=filter_type, comment=comment, term=term
)
)
def modify_filter(
self,
filter_id: EntityID,
*,
comment: Optional[str] = None,
name: Optional[str] = None,
term: Optional[str] = None,
filter_type: Optional[FilterType] = None, # type: ignore[override]
) -> T:
"""Modifies an existing filter.
Args:
filter_id: UUID of the filter to be modified
comment: Comment on filter.
name: Name of filter.
term: Filter term.
filter_type: Resource type filter applies to.
"""
# override create_filter because of the different FilterType enum
# this avoids warnings with type checkers
return self._send_request_and_transform_response(
Filters.modify_filter(
filter_id,
comment=comment,
name=name,
term=term,
filter_type=filter_type,
)
)
def clone_report_config(self, report_config_id: EntityID) -> T:
"""Clone a report config from an existing one
Args:
report_config_id: UUID of the existing report config
"""
return self._send_request_and_transform_response(
ReportConfigs.clone_report_config(report_config_id)
)
def delete_report_config(
self,
report_config_id: EntityID,
*,
ultimate: Optional[bool] = False,
) -> T:
"""Deletes an existing report config
Args:
report_config_id: UUID of the report config to be deleted.
ultimate: Whether to remove entirely, or to the trashcan.
"""
return self._send_request_and_transform_response(
ReportConfigs.delete_report_config(
report_config_id, ultimate=ultimate
)
)
def get_report_configs(
self,
*,
filter_string: Optional[str] = None,
filter_id: Optional[EntityID] = None,
trash: Optional[bool] = None,
details: Optional[bool] = None,
) -> T:
"""Request a list of report configs
Args:
filter_string: Filter term to use for the query
filter_id: UUID of an existing filter to use for the query
trash: Whether to get the trashcan report configs instead
details: Include report config details
"""
return self._send_request_and_transform_response(
ReportConfigs.get_report_configs(
filter_string=filter_string,
filter_id=filter_id,
trash=trash,
details=details,
)
)
def get_report_config(
self,
report_config_id: EntityID,
) -> T:
"""Request a single report config
Args:
report_config_id: UUID of an existing report config
"""
return self._send_request_and_transform_response(
ReportConfigs.get_report_config(report_config_id)
)
def create_report_config(
self,
name: str,
report_format_id: Union[EntityID, ReportFormatType],
*,
comment: Optional[str] = None,
params: Optional[Sequence[ReportConfigParameter]] = None,
) -> T:
"""Create a report config
Args:
name: Name of the new report config
report_format_id: UUID of the report format to be used or ReportFormatType.
comment: An optional comment for the report config.
params: A list of report config parameters.
"""
return self._send_request_and_transform_response(
ReportConfigs.create_report_config(
name, report_format_id, comment=comment, params=params
)
)
def modify_report_config(
self,
report_config_id: EntityID,
*,
name: Optional[str] = None,
comment: Optional[str] = None,
params: Optional[Sequence[ReportConfigParameter]] = None,
) -> T:
"""Create a report config
Args:
name: Name of the report config
report_config_id: UUID of the report config to be modified.
comment: An optional comment for the report config.
params: A list of report config parameters.
"""
return self._send_request_and_transform_response(
ReportConfigs.modify_report_config(
report_config_id, name=name, comment=comment, params=params
)
)
|
