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
|
# SPDX-FileCopyrightText: 2025 Greenbone AG
#
# SPDX-License-Identifier: GPL-3.0-or-later
"""
Greenbone Management Protocol (GMP) version 22.7
"""
from typing import Optional, Union
from .._protocol import T
from ._gmp226 import GMPv226
from .requests.v227 import (
EntityID,
Scanners,
ScannerType,
)
class GMPv227(GMPv226[T]):
"""
A class implementing the Greenbone Management Protocol (GMP) version 22.7
Example:
.. code-block:: python
from gvm.protocols.gmp import GMPv227 as GMP
with GMP(connection) as gmp:
resp = gmp.get_tasks()
"""
@staticmethod
def get_protocol_version() -> tuple[int, int]:
return (22, 7)
def create_scanner( # type:ignore[override]
self,
name: str,
host: str,
port: Union[str, int],
scanner_type: ScannerType,
credential_id: str,
*,
ca_pub: Optional[str] = None,
comment: Optional[str] = None,
relay_host: Optional[str] = None,
relay_port: Optional[Union[str, int]] = None,
) -> T:
"""Create a new scanner
Args:
name: Name of the new scanner
host: Hostname or IP address of the scanner
port: Port of the scanner
scanner_type: Type of the scanner
credential_id: UUID of client certificate credential for the
scanner
ca_pub: Certificate of CA to verify scanner certificate
comment: Comment for the scanner
relay_host: Hostname or IP address of the scanner relay
relay_port: Port of the scanner relay
"""
return self._send_request_and_transform_response(
Scanners.create_scanner(
name,
host,
port,
scanner_type,
credential_id,
ca_pub=ca_pub,
comment=comment,
relay_host=relay_host,
relay_port=relay_port,
)
)
def modify_scanner( # type:ignore[override]
self,
scanner_id: EntityID,
*,
name: Optional[str] = None,
host: Optional[str] = None,
port: Optional[int] = None,
scanner_type: Optional[ScannerType] = None,
credential_id: Optional[EntityID] = None,
ca_pub: Optional[str] = None,
comment: Optional[str] = None,
relay_host: Optional[str] = None,
relay_port: Optional[Union[str, int]] = None,
) -> T:
"""Modify an existing scanner
Args:
scanner_id: UUID of the scanner to modify
name: New name of the scanner
host: New hostname or IP address of the scanner
port: New port of the scanner
scanner_type: New type of the scanner
credential_id: New UUID of client certificate credential for the
scanner
ca_pub: New certificate of CA to verify scanner certificate
comment: New comment for the scanner
relay_host: Hostname or IP address of the scanner relay
relay_port: Port of the scanner relay
"""
return self._send_request_and_transform_response(
Scanners.modify_scanner(
scanner_id,
name=name,
host=host,
port=port,
scanner_type=scanner_type,
credential_id=credential_id,
ca_pub=ca_pub,
comment=comment,
relay_host=relay_host,
relay_port=relay_port,
)
)
def get_scanners(
self,
*,
filter_string: Optional[str] = None,
filter_id: Optional[EntityID] = None,
trash: Optional[bool] = None,
details: Optional[bool] = None,
) -> T:
"""Request a list of scanners
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 scanners instead
details: Whether to include extra details like tasks using this
scanner
"""
return self._send_request_and_transform_response(
Scanners.get_scanners(
filter_string=filter_string,
filter_id=filter_id,
trash=trash,
details=details,
)
)
def get_scanner(self, scanner_id: EntityID) -> T:
"""Request a single scanner
Args:
scanner_id: UUID of an existing scanner
"""
return self._send_request_and_transform_response(
Scanners.get_scanner(scanner_id)
)
def verify_scanner(self, scanner_id: EntityID) -> T:
"""Verify an existing scanner
Args:
scanner_id: UUID of an existing scanner
"""
return self._send_request_and_transform_response(
Scanners.verify_scanner(scanner_id)
)
def clone_scanner(self, scanner_id: EntityID) -> T:
"""Clone an existing scanner
Args:
scanner_id: UUID of an existing scanner
"""
return self._send_request_and_transform_response(
Scanners.clone_scanner(scanner_id)
)
def delete_scanner(
self, scanner_id: EntityID, ultimate: Optional[bool] = False
) -> T:
"""Delete an existing scanner
Args:
scanner_id: UUID of an existing scanner
ultimate: Whether to remove entirely, or to the trashcan.
"""
return self._send_request_and_transform_response(
Scanners.delete_scanner(scanner_id, ultimate=ultimate)
)
|
