1
|
|
|
# -*- coding: utf-8 -*- |
2
|
|
|
# Copyright (C) 2018 Greenbone Networks GmbH |
3
|
|
|
# |
4
|
|
|
# SPDX-License-Identifier: GPL-3.0-or-later |
5
|
|
|
# |
6
|
|
|
# This program is free software: you can redistribute it and/or modify |
7
|
|
|
# it under the terms of the GNU General Public License as published by |
8
|
|
|
# the Free Software Foundation, either version 3 of the License, or |
9
|
|
|
# (at your option) any later version. |
10
|
|
|
# |
11
|
|
|
# This program is distributed in the hope that it will be useful, |
12
|
|
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of |
13
|
|
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
14
|
|
|
# GNU General Public License for more details. |
15
|
|
|
# |
16
|
|
|
# You should have received a copy of the GNU General Public License |
17
|
|
|
# along with this program. If not, see <http://www.gnu.org/licenses/>. |
18
|
|
|
""" |
19
|
|
|
Module for communication with gvmd in Greenbone Management Protocol version 7 |
20
|
|
|
""" |
21
|
|
|
import logging |
22
|
|
|
|
23
|
|
|
from lxml import etree |
24
|
|
|
|
25
|
|
|
from gmp.protocols.base import Protocol |
26
|
|
|
from gmp.xml import _GmpCommandFactory as GmpCommandFactory |
27
|
|
|
|
28
|
|
|
logger = logging.getLogger(__name__) |
|
|
|
|
29
|
|
|
|
30
|
|
|
PROTOCOL_VERSION = (7,) |
31
|
|
|
|
32
|
|
|
|
33
|
|
|
def _check_command_status(xml): |
34
|
|
|
"""Check gmp response |
35
|
|
|
|
36
|
|
|
Look into the gmp response and check for the status in the root element |
37
|
|
|
|
38
|
|
|
Arguments: |
39
|
|
|
xml {string} -- XML-Source |
40
|
|
|
|
41
|
|
|
Returns: |
42
|
|
|
bool -- True if valid, otherwise False |
43
|
|
|
""" |
44
|
|
|
|
45
|
|
|
if xml is 0 or xml is None: |
46
|
|
|
logger.error('XML Command is empty') |
47
|
|
|
return False |
48
|
|
|
|
49
|
|
|
try: |
50
|
|
|
parser = etree.XMLParser(encoding='utf-8', recover=True) |
|
|
|
|
51
|
|
|
|
52
|
|
|
root = etree.XML(xml, parser=parser) |
|
|
|
|
53
|
|
|
status = root.attrib['status'] |
54
|
|
|
return status is not None and status[0] == '2' |
55
|
|
|
|
56
|
|
|
except etree.Error as e: |
|
|
|
|
57
|
|
|
logger.error('etree.XML(xml): %s', e) |
58
|
|
|
return False |
59
|
|
|
|
60
|
|
|
|
61
|
|
|
class Gmp(Protocol): |
|
|
|
|
62
|
|
|
"""Python interface for Greenbone Management Protocol |
63
|
|
|
|
64
|
|
|
This class implements the `Greenbone Management Protocol version 7`_ |
65
|
|
|
|
66
|
|
|
Attributes: |
67
|
|
|
connection (:class:`gmp.connections.GmpConnection`): Connection to use |
68
|
|
|
to talk with the gvmd daemon. See :mod:`gmp.connections` for |
69
|
|
|
possible connection types. |
70
|
|
|
transform (`callable`_, optional): Optional transform callable to |
71
|
|
|
convert response data. After each request the callable gets passed |
72
|
|
|
the plain response data which can be used to check the data and/or |
73
|
|
|
conversion into different representaitions like a xml dom. |
74
|
|
|
|
75
|
|
|
See :mod:`gmp.transforms` for existing transforms. |
76
|
|
|
|
77
|
|
|
.. _Greenbone Management Protocol version 7: |
78
|
|
|
https://docs.greenbone.net/API/GMP/gmp-7.0.html |
79
|
|
|
.. _callable: |
80
|
|
|
https://docs.python.org/3.6/library/functions.html#callable |
81
|
|
|
""" |
82
|
|
|
|
83
|
|
|
def __init__(self, connection, transform=None): |
84
|
|
|
super().__init__(connection, transform) |
85
|
|
|
|
86
|
|
|
# Is authenticated on gvmd |
87
|
|
|
self._authenticated = False |
88
|
|
|
|
89
|
|
|
# GMP Message Creator |
90
|
|
|
self._generator = GmpCommandFactory() |
91
|
|
|
|
92
|
|
|
@staticmethod |
93
|
|
|
def get_protocol_version(): |
94
|
|
|
"""Allow to determine the Greenbone Management Protocol version. |
95
|
|
|
|
96
|
|
|
Returns: |
97
|
|
|
str: Implemented version of the Greenbone Management Protocol |
98
|
|
|
""" |
99
|
|
|
return '.'.join(str(x) for x in PROTOCOL_VERSION) |
100
|
|
|
|
101
|
|
|
def is_authenticated(self): |
102
|
|
|
"""Checks if the user is authenticated |
103
|
|
|
|
104
|
|
|
If the user is authenticated privilged GMP commands like get_tasks |
105
|
|
|
may be send to gvmd. |
106
|
|
|
|
107
|
|
|
Returns: |
108
|
|
|
bool: True if an authenticated connection to gvmd has been |
109
|
|
|
established. |
110
|
|
|
""" |
111
|
|
|
return self._authenticated |
112
|
|
|
|
113
|
|
|
def authenticate(self, username, password): |
114
|
|
|
"""Authenticate to gvmd. |
115
|
|
|
|
116
|
|
|
The generated authenticate command will be send to server. |
117
|
|
|
Afterwards the response is read, tranformed and returned. |
118
|
|
|
|
119
|
|
|
Arguments: |
120
|
|
|
username (str): Username |
121
|
|
|
password (str): Password |
122
|
|
|
|
123
|
|
|
Returns: |
124
|
|
|
any, str by default: Transformed response from server. |
125
|
|
|
""" |
126
|
|
|
cmd = self._generator.create_authenticate_command( |
127
|
|
|
username=username, password=password) |
128
|
|
|
|
129
|
|
|
self._send(cmd) |
130
|
|
|
response = self._read() |
131
|
|
|
|
132
|
|
|
if _check_command_status(response): |
133
|
|
|
self._authenticated = True |
134
|
|
|
|
135
|
|
|
return self._transform(response) |
136
|
|
|
|
137
|
|
|
def create_agent(self, installer, signature, name, comment='', copy='', |
|
|
|
|
138
|
|
|
howto_install='', howto_use=''): |
139
|
|
|
cmd = self._generator.create_agent_command( |
140
|
|
|
installer, signature, name, comment, copy, howto_install, |
141
|
|
|
howto_use) |
142
|
|
|
return self.send_command(cmd) |
143
|
|
|
|
144
|
|
|
def create_alert(self, name, condition, event, method, filter_id='', |
|
|
|
|
145
|
|
|
copy='', comment=''): |
146
|
|
|
cmd = self._generator.create_alert_command(name, condition, event, |
147
|
|
|
method, filter_id, copy, |
148
|
|
|
comment) |
149
|
|
|
return self.send_command(cmd) |
150
|
|
|
|
151
|
|
|
def create_asset(self, name, asset_type, comment=''): |
|
|
|
|
152
|
|
|
# TODO: Add the missing second method. Also the docs are not complete! |
|
|
|
|
153
|
|
|
cmd = self._generator.create_asset_command(name, asset_type, comment) |
154
|
|
|
return self.send_command(cmd) |
155
|
|
|
|
156
|
|
|
def create_config(self, copy_id, name): |
|
|
|
|
157
|
|
|
cmd = self._generator.create_config_command(copy_id, name) |
158
|
|
|
return self.send_command(cmd) |
159
|
|
|
|
160
|
|
|
def create_credential(self, name, **kwargs): |
|
|
|
|
161
|
|
|
cmd = self._generator.create_credential_command(name, kwargs) |
162
|
|
|
return self.send_command(cmd) |
163
|
|
|
|
164
|
|
|
def create_filter(self, name, make_unique, **kwargs): |
|
|
|
|
165
|
|
|
cmd = self._generator.create_filter_command(name, make_unique, |
166
|
|
|
kwargs) |
167
|
|
|
return self.send_command(cmd) |
168
|
|
|
|
169
|
|
|
def create_group(self, name, **kwargs): |
|
|
|
|
170
|
|
|
cmd = self._generator.create_group_command(name, kwargs) |
171
|
|
|
return self.send_command(cmd) |
172
|
|
|
|
173
|
|
|
# TODO: Create notes with comment returns bogus element. Research |
|
|
|
|
174
|
|
|
def create_note(self, text, nvt_oid, **kwargs): |
|
|
|
|
175
|
|
|
cmd = self._generator.create_note_command(text, nvt_oid, kwargs) |
176
|
|
|
return self.send_command(cmd) |
177
|
|
|
|
178
|
|
|
def create_override(self, text, nvt_oid, **kwargs): |
|
|
|
|
179
|
|
|
cmd = self._generator.create_override_command(text, nvt_oid, kwargs) |
180
|
|
|
return self.send_command(cmd) |
181
|
|
|
|
182
|
|
|
def create_permission(self, name, subject_id, permission_type, **kwargs): |
|
|
|
|
183
|
|
|
cmd = self._generator.create_permission_command( |
184
|
|
|
name, subject_id, permission_type, kwargs) |
185
|
|
|
return self.send_command(cmd) |
186
|
|
|
|
187
|
|
|
def create_port_list(self, name, port_range, **kwargs): |
|
|
|
|
188
|
|
|
cmd = self._generator.create_port_list_command(name, port_range, kwargs) |
189
|
|
|
return self.send_command(cmd) |
190
|
|
|
|
191
|
|
|
def create_port_range(self, port_list_id, start, end, port_range_type, |
|
|
|
|
192
|
|
|
comment=''): |
193
|
|
|
cmd = self._generator.create_port_range_command( |
194
|
|
|
port_list_id, start, end, port_range_type, comment) |
195
|
|
|
return self.send_command(cmd) |
196
|
|
|
|
197
|
|
|
def create_report(self, report_xml_string, **kwargs): |
|
|
|
|
198
|
|
|
cmd = self._generator.create_report_command(report_xml_string, kwargs) |
199
|
|
|
return self.send_command(cmd) |
200
|
|
|
|
201
|
|
|
def create_role(self, name, **kwargs): |
|
|
|
|
202
|
|
|
cmd = self._generator.create_role_command(name, kwargs) |
203
|
|
|
return self.send_command(cmd) |
204
|
|
|
|
205
|
|
|
def create_scanner(self, name, host, port, scanner_type, ca_pub, |
|
|
|
|
206
|
|
|
credential_id, **kwargs): |
207
|
|
|
cmd = self._generator.create_scanner_command(name, host, port, |
208
|
|
|
scanner_type, ca_pub, |
209
|
|
|
credential_id, kwargs) |
210
|
|
|
return self.send_command(cmd) |
211
|
|
|
|
212
|
|
|
def create_schedule(self, name, **kwargs): |
|
|
|
|
213
|
|
|
cmd = self._generator.create_schedule_command(name, kwargs) |
214
|
|
|
return self.send_command(cmd) |
215
|
|
|
|
216
|
|
|
def create_tag(self, name, resource_id, resource_type, **kwargs): |
|
|
|
|
217
|
|
|
cmd = self._generator.create_tag_command(name, resource_id, |
218
|
|
|
resource_type, kwargs) |
219
|
|
|
return self.send_command(cmd) |
220
|
|
|
|
221
|
|
|
def create_target(self, name, make_unique, **kwargs): |
|
|
|
|
222
|
|
|
# TODO: Missing variables |
|
|
|
|
223
|
|
|
cmd = self._generator.create_target_command(name, make_unique, kwargs) |
224
|
|
|
return self.send_command(cmd) |
225
|
|
|
|
226
|
|
|
def create_task(self, name, config_id, target_id, scanner_id, |
|
|
|
|
227
|
|
|
alert_ids=None, comment=''): |
228
|
|
|
if alert_ids is None: |
229
|
|
|
alert_ids = [] |
230
|
|
|
cmd = self._generator.create_task_command( |
231
|
|
|
name, config_id, target_id, scanner_id, alert_ids, comment) |
232
|
|
|
return self.send_command(cmd) |
233
|
|
|
|
234
|
|
|
def create_user(self, name, password, copy='', hosts_allow='0', |
|
|
|
|
235
|
|
|
ifaces_allow='0', role_ids=(), hosts=None, ifaces=None): |
236
|
|
|
cmd = self._generator.create_user_command( |
237
|
|
|
name, password, copy, hosts_allow, ifaces_allow, role_ids, hosts, |
238
|
|
|
ifaces) |
239
|
|
|
return self.send_command(cmd) |
240
|
|
|
|
241
|
|
|
def delete_agent(self, **kwargs): |
|
|
|
|
242
|
|
|
cmd = self._generator.delete_agent_command(kwargs) |
243
|
|
|
return self.send_command(cmd) |
244
|
|
|
|
245
|
|
|
def delete_alert(self, **kwargs): |
|
|
|
|
246
|
|
|
cmd = self._generator.delete_alert_command(kwargs) |
247
|
|
|
return self.send_command(cmd) |
248
|
|
|
|
249
|
|
|
def delete_asset(self, asset_id, ultimate=0): |
|
|
|
|
250
|
|
|
cmd = self._generator.delete_asset_command(asset_id, ultimate) |
251
|
|
|
return self.send_command(cmd) |
252
|
|
|
|
253
|
|
|
def delete_config(self, config_id, ultimate=0): |
|
|
|
|
254
|
|
|
cmd = self._generator.delete_config_command(config_id, ultimate) |
255
|
|
|
return self.send_command(cmd) |
256
|
|
|
|
257
|
|
|
def delete_credential(self, credential_id, ultimate=0): |
|
|
|
|
258
|
|
|
cmd = self._generator.delete_credential_command(credential_id, ultimate) |
259
|
|
|
return self.send_command(cmd) |
260
|
|
|
|
261
|
|
|
def delete_filter(self, filter_id, ultimate=0): |
|
|
|
|
262
|
|
|
cmd = self._generator.delete_filter_command(filter_id, ultimate) |
263
|
|
|
return self.send_command(cmd) |
264
|
|
|
|
265
|
|
|
def delete_group(self, group_id, ultimate=0): |
|
|
|
|
266
|
|
|
cmd = self._generator.delete_group_command(group_id, ultimate) |
267
|
|
|
return self.send_command(cmd) |
268
|
|
|
|
269
|
|
|
def delete_note(self, note_id, ultimate=0): |
|
|
|
|
270
|
|
|
cmd = self._generator.delete_note_command(note_id, ultimate) |
271
|
|
|
return self.send_command(cmd) |
272
|
|
|
|
273
|
|
|
def delete_override(self, override_id, ultimate=0): |
|
|
|
|
274
|
|
|
cmd = self._generator.delete_override_command(override_id, ultimate) |
275
|
|
|
return self.send_command(cmd) |
276
|
|
|
|
277
|
|
|
def delete_permission(self, permission_id, ultimate=0): |
|
|
|
|
278
|
|
|
cmd = self._generator.delete_permission_command(permission_id, ultimate) |
279
|
|
|
return self.send_command(cmd) |
280
|
|
|
|
281
|
|
|
def delete_port_list(self, port_list_id, ultimate=0): |
|
|
|
|
282
|
|
|
cmd = self._generator.delete_port_list_command(port_list_id, ultimate) |
283
|
|
|
return self.send_command(cmd) |
284
|
|
|
|
285
|
|
|
def delete_port_range(self, port_range_id): |
|
|
|
|
286
|
|
|
cmd = self._generator.delete_port_range_command(port_range_id) |
287
|
|
|
return self.send_command(cmd) |
288
|
|
|
|
289
|
|
|
def delete_report(self, report_id): |
|
|
|
|
290
|
|
|
cmd = self._generator.delete_report_command(report_id) |
291
|
|
|
return self.send_command(cmd) |
292
|
|
|
|
293
|
|
|
def delete_report_format(self, report_format_id, ultimate=0): |
|
|
|
|
294
|
|
|
cmd = self._generator.delete_report_format_command( |
295
|
|
|
report_format_id, ultimate) |
296
|
|
|
return self.send_command(cmd) |
297
|
|
|
|
298
|
|
|
def delete_role(self, role_id, ultimate=0): |
|
|
|
|
299
|
|
|
cmd = self._generator.delete_role_command(role_id, ultimate) |
300
|
|
|
return self.send_command(cmd) |
301
|
|
|
|
302
|
|
|
def delete_scanner(self, scanner_id, ultimate=0): |
|
|
|
|
303
|
|
|
cmd = self._generator.delete_scanner_command(scanner_id, ultimate) |
304
|
|
|
return self.send_command(cmd) |
305
|
|
|
|
306
|
|
|
def delete_schedule(self, schedule_id, ultimate=0): |
|
|
|
|
307
|
|
|
cmd = self._generator.delete_schedule_command(schedule_id, ultimate) |
308
|
|
|
return self.send_command(cmd) |
309
|
|
|
|
310
|
|
|
def delete_tag(self, tag_id, ultimate=0): |
|
|
|
|
311
|
|
|
cmd = self._generator.delete_tag_command(tag_id, ultimate) |
312
|
|
|
return self.send_command(cmd) |
313
|
|
|
|
314
|
|
|
def delete_target(self, target_id, ultimate=0): |
|
|
|
|
315
|
|
|
cmd = self._generator.delete_target_command(target_id, ultimate) |
316
|
|
|
return self.send_command(cmd) |
317
|
|
|
|
318
|
|
|
def delete_task(self, task_id, ultimate=0): |
|
|
|
|
319
|
|
|
cmd = self._generator.delete_task_command(task_id, ultimate) |
320
|
|
|
return self.send_command(cmd) |
321
|
|
|
|
322
|
|
|
def delete_user(self, **kwargs): |
|
|
|
|
323
|
|
|
cmd = self._generator.delete_user_command(kwargs) |
324
|
|
|
return self.send_command(cmd) |
325
|
|
|
|
326
|
|
|
def describe_auth(self): |
|
|
|
|
327
|
|
|
cmd = self._generator.describe_auth_command() |
328
|
|
|
return self.send_command(cmd) |
329
|
|
|
|
330
|
|
|
def empty_trashcan(self): |
|
|
|
|
331
|
|
|
cmd = self._generator.empty_trashcan_command() |
332
|
|
|
return self.send_command(cmd) |
333
|
|
|
|
334
|
|
|
def get_agents(self, **kwargs): |
|
|
|
|
335
|
|
|
cmd = self._generator.get_agents_command(kwargs) |
336
|
|
|
return self.send_command(cmd) |
337
|
|
|
|
338
|
|
|
def get_aggregates(self, **kwargs): |
|
|
|
|
339
|
|
|
cmd = self._generator.get_aggregates_command(kwargs) |
340
|
|
|
return self.send_command(cmd) |
341
|
|
|
|
342
|
|
|
def get_alerts(self, **kwargs): |
|
|
|
|
343
|
|
|
cmd = self._generator.get_alerts_command(kwargs) |
344
|
|
|
return self.send_command(cmd) |
345
|
|
|
|
346
|
|
|
def get_assets(self, **kwargs): |
|
|
|
|
347
|
|
|
cmd = self._generator.get_assets_command(kwargs) |
348
|
|
|
return self.send_command(cmd) |
349
|
|
|
|
350
|
|
|
def get_credentials(self, **kwargs): |
|
|
|
|
351
|
|
|
cmd = self._generator.get_credentials_command(kwargs) |
352
|
|
|
return self.send_command(cmd) |
353
|
|
|
|
354
|
|
|
def get_configs(self, **kwargs): |
|
|
|
|
355
|
|
|
cmd = self._generator.get_configs_command(kwargs) |
356
|
|
|
return self.send_command(cmd) |
357
|
|
|
|
358
|
|
|
def get_feeds(self, **kwargs): |
|
|
|
|
359
|
|
|
cmd = self._generator.get_feeds_command(kwargs) |
360
|
|
|
return self.send_command(cmd) |
361
|
|
|
|
362
|
|
|
def get_filters(self, **kwargs): |
|
|
|
|
363
|
|
|
cmd = self._generator.get_filters_command(kwargs) |
364
|
|
|
return self.send_command(cmd) |
365
|
|
|
|
366
|
|
|
def get_groups(self, **kwargs): |
|
|
|
|
367
|
|
|
cmd = self._generator.get_groups_command(kwargs) |
368
|
|
|
return self.send_command(cmd) |
369
|
|
|
|
370
|
|
|
def get_info(self, **kwargs): |
|
|
|
|
371
|
|
|
cmd = self._generator.get_info_command(kwargs) |
372
|
|
|
return self.send_command(cmd) |
373
|
|
|
|
374
|
|
|
def get_notes(self, **kwargs): |
|
|
|
|
375
|
|
|
cmd = self._generator.get_notes_command(kwargs) |
376
|
|
|
return self.send_command(cmd) |
377
|
|
|
|
378
|
|
|
def get_nvts(self, **kwargs): |
|
|
|
|
379
|
|
|
cmd = self._generator.get_nvts_command(kwargs) |
380
|
|
|
return self.send_command(cmd) |
381
|
|
|
|
382
|
|
|
def get_nvt_families(self, **kwargs): |
|
|
|
|
383
|
|
|
cmd = self._generator.get_nvt_families_command(kwargs) |
384
|
|
|
return self.send_command(cmd) |
385
|
|
|
|
386
|
|
|
def get_overrides(self, **kwargs): |
|
|
|
|
387
|
|
|
cmd = self._generator.get_overrides_command(kwargs) |
388
|
|
|
return self.send_command(cmd) |
389
|
|
|
|
390
|
|
|
def get_permissions(self, **kwargs): |
|
|
|
|
391
|
|
|
cmd = self._generator.get_permissions_command(kwargs) |
392
|
|
|
return self.send_command(cmd) |
393
|
|
|
|
394
|
|
|
def get_port_lists(self, **kwargs): |
|
|
|
|
395
|
|
|
cmd = self._generator.get_port_lists_command(kwargs) |
396
|
|
|
return self.send_command(cmd) |
397
|
|
|
|
398
|
|
|
def get_preferences(self, **kwargs): |
|
|
|
|
399
|
|
|
cmd = self._generator.get_preferences_command(kwargs) |
400
|
|
|
return self.send_command(cmd) |
401
|
|
|
|
402
|
|
|
def get_reports(self, **kwargs): |
|
|
|
|
403
|
|
|
cmd = self._generator.get_reports_command(kwargs) |
404
|
|
|
return self.send_command(cmd) |
405
|
|
|
|
406
|
|
|
def get_report_formats(self, **kwargs): |
|
|
|
|
407
|
|
|
cmd = self._generator.get_report_formats_command(kwargs) |
408
|
|
|
return self.send_command(cmd) |
409
|
|
|
|
410
|
|
|
def get_results(self, **kwargs): |
|
|
|
|
411
|
|
|
cmd = self._generator.get_results_command(kwargs) |
412
|
|
|
return self.send_command(cmd) |
413
|
|
|
|
414
|
|
|
def get_roles(self, **kwargs): |
|
|
|
|
415
|
|
|
cmd = self._generator.get_roles_command(kwargs) |
416
|
|
|
return self.send_command(cmd) |
417
|
|
|
|
418
|
|
|
def get_scanners(self, **kwargs): |
|
|
|
|
419
|
|
|
cmd = self._generator.get_scanners_command(kwargs) |
420
|
|
|
return self.send_command(cmd) |
421
|
|
|
|
422
|
|
|
def get_schedules(self, **kwargs): |
|
|
|
|
423
|
|
|
cmd = self._generator.get_schedules_command(kwargs) |
424
|
|
|
return self.send_command(cmd) |
425
|
|
|
|
426
|
|
|
def get_settings(self, **kwargs): |
|
|
|
|
427
|
|
|
cmd = self._generator.get_settings_command(kwargs) |
428
|
|
|
return self.send_command(cmd) |
429
|
|
|
|
430
|
|
|
def get_system_reports(self, **kwargs): |
|
|
|
|
431
|
|
|
cmd = self._generator.get_system_reports_command(kwargs) |
432
|
|
|
return self.send_command(cmd) |
433
|
|
|
|
434
|
|
|
def get_tags(self, **kwargs): |
|
|
|
|
435
|
|
|
cmd = self._generator.get_tags_command(kwargs) |
436
|
|
|
return self.send_command(cmd) |
437
|
|
|
|
438
|
|
|
def get_targets(self, **kwargs): |
|
|
|
|
439
|
|
|
cmd = self._generator.get_targets_command(kwargs) |
440
|
|
|
return self.send_command(cmd) |
441
|
|
|
|
442
|
|
|
def get_tasks(self, **kwargs): |
|
|
|
|
443
|
|
|
cmd = self._generator.get_tasks_command(kwargs) |
444
|
|
|
return self.send_command(cmd) |
445
|
|
|
|
446
|
|
|
def get_users(self, **kwargs): |
|
|
|
|
447
|
|
|
cmd = self._generator.get_users_command(kwargs) |
448
|
|
|
return self.send_command(cmd) |
449
|
|
|
|
450
|
|
|
def get_version(self): |
|
|
|
|
451
|
|
|
cmd = self._generator.get_version_command() |
452
|
|
|
return self.send_command(cmd) |
453
|
|
|
|
454
|
|
|
def help(self, **kwargs): |
|
|
|
|
455
|
|
|
cmd = self._generator.help_command(kwargs) |
456
|
|
|
return self.send_command(cmd) |
457
|
|
|
|
458
|
|
|
def modify_agent(self, agent_id, name='', comment=''): |
|
|
|
|
459
|
|
|
cmd = self._generator.modify_agent_command(agent_id, name, comment) |
460
|
|
|
return self.send_command(cmd) |
461
|
|
|
|
462
|
|
|
def modify_alert(self, alert_id, **kwargs): |
|
|
|
|
463
|
|
|
cmd = self._generator.modify_alert_command(alert_id, kwargs) |
464
|
|
|
return self.send_command(cmd) |
465
|
|
|
|
466
|
|
|
def modify_asset(self, asset_id, comment): |
|
|
|
|
467
|
|
|
cmd = self._generator.modify_asset_command(asset_id, comment) |
468
|
|
|
return self.send_command(cmd) |
469
|
|
|
|
470
|
|
|
def modify_auth(self, group_name, auth_conf_settings): |
|
|
|
|
471
|
|
|
cmd = self._generator.modify_auth_command(group_name, |
472
|
|
|
auth_conf_settings) |
473
|
|
|
return self.send_command(cmd) |
474
|
|
|
|
475
|
|
|
def modify_config(self, selection, **kwargs): |
|
|
|
|
476
|
|
|
cmd = self._generator.modify_config_command(selection, kwargs) |
477
|
|
|
return self.send_command(cmd) |
478
|
|
|
|
479
|
|
|
def modify_credential(self, credential_id, **kwargs): |
|
|
|
|
480
|
|
|
cmd = self._generator.modify_credential_command( |
481
|
|
|
credential_id, kwargs) |
482
|
|
|
return self.send_command(cmd) |
483
|
|
|
|
484
|
|
|
def modify_filter(self, filter_id, **kwargs): |
|
|
|
|
485
|
|
|
cmd = self._generator.modify_filter_command(filter_id, kwargs) |
486
|
|
|
return self.send_command(cmd) |
487
|
|
|
|
488
|
|
|
def modify_group(self, group_id, **kwargs): |
|
|
|
|
489
|
|
|
cmd = self._generator.modify_group_command(group_id, kwargs) |
490
|
|
|
return self.send_command(cmd) |
491
|
|
|
|
492
|
|
|
def modify_note(self, note_id, text, **kwargs): |
|
|
|
|
493
|
|
|
cmd = self._generator.modify_note_command(note_id, text, kwargs) |
494
|
|
|
return self.send_command(cmd) |
495
|
|
|
|
496
|
|
|
def modify_override(self, override_id, text, **kwargs): |
|
|
|
|
497
|
|
|
cmd = self._generator.modify_override_command(override_id, text, |
498
|
|
|
kwargs) |
499
|
|
|
return self.send_command(cmd) |
500
|
|
|
|
501
|
|
|
def modify_permission(self, permission_id, **kwargs): |
|
|
|
|
502
|
|
|
cmd = self._generator.modify_permission_command( |
503
|
|
|
permission_id, kwargs) |
504
|
|
|
return self.send_command(cmd) |
505
|
|
|
|
506
|
|
|
def modify_port_list(self, port_list_id, **kwargs): |
|
|
|
|
507
|
|
|
cmd = self._generator.modify_port_list_command(port_list_id, kwargs) |
508
|
|
|
return self.send_command(cmd) |
509
|
|
|
|
510
|
|
|
def modify_report(self, report_id, comment): |
|
|
|
|
511
|
|
|
cmd = self._generator.modify_report_format_command(report_id, comment) |
512
|
|
|
return self.send_command(cmd) |
513
|
|
|
|
514
|
|
|
def modify_report_format(self, report_format_id, **kwargs): |
|
|
|
|
515
|
|
|
cmd = self._generator.modify_report_format_command(report_format_id, |
516
|
|
|
kwargs) |
517
|
|
|
return self.send_command(cmd) |
518
|
|
|
|
519
|
|
|
def modify_role(self, role_id, **kwargs): |
|
|
|
|
520
|
|
|
cmd = self._generator.modify_role_command(role_id, kwargs) |
521
|
|
|
return self.send_command(cmd) |
522
|
|
|
|
523
|
|
|
def modify_scanner(self, scanner_id, host, port, scanner_type, **kwargs): |
|
|
|
|
524
|
|
|
cmd = self._generator.modify_scanner_command(scanner_id, host, port, |
525
|
|
|
scanner_type, kwargs) |
526
|
|
|
return self.send_command(cmd) |
527
|
|
|
|
528
|
|
|
def modify_schedule(self, schedule_id, **kwargs): |
|
|
|
|
529
|
|
|
cmd = self._generator.modify_schedule_command(schedule_id, kwargs) |
530
|
|
|
return self.send_command(cmd) |
531
|
|
|
|
532
|
|
|
def modify_setting(self, setting_id, name, value): |
|
|
|
|
533
|
|
|
cmd = self._generator.modify_setting_command(setting_id, name, value) |
534
|
|
|
return self.send_command(cmd) |
535
|
|
|
|
536
|
|
|
def modify_tag(self, tag_id, **kwargs): |
|
|
|
|
537
|
|
|
cmd = self._generator.modify_tag_command(tag_id, kwargs) |
538
|
|
|
return self.send_command(cmd) |
539
|
|
|
|
540
|
|
|
def modify_target(self, target_id, **kwargs): |
|
|
|
|
541
|
|
|
cmd = self._generator.modify_target_command(target_id, kwargs) |
542
|
|
|
return self.send_command(cmd) |
543
|
|
|
|
544
|
|
|
def modify_task(self, task_id, **kwargs): |
|
|
|
|
545
|
|
|
cmd = self._generator.modify_task_command(task_id, kwargs) |
546
|
|
|
return self.send_command(cmd) |
547
|
|
|
|
548
|
|
|
def modify_user(self, **kwargs): |
|
|
|
|
549
|
|
|
cmd = self._generator.modify_user_command(kwargs) |
550
|
|
|
return self.send_command(cmd) |
551
|
|
|
|
552
|
|
|
def move_task(self, task_id, slave_id): |
|
|
|
|
553
|
|
|
cmd = self._generator.move_task_command(task_id, slave_id) |
554
|
|
|
return self.send_command(cmd) |
555
|
|
|
|
556
|
|
|
def restore(self, entity_id): |
|
|
|
|
557
|
|
|
cmd = self._generator.restore_command(entity_id) |
558
|
|
|
return self.send_command(cmd) |
559
|
|
|
|
560
|
|
|
def resume_task(self, task_id): |
|
|
|
|
561
|
|
|
cmd = self._generator.resume_task_command(task_id) |
562
|
|
|
return self.send_command(cmd) |
563
|
|
|
|
564
|
|
|
def start_task(self, task_id): |
|
|
|
|
565
|
|
|
cmd = self._generator.start_task_command(task_id) |
566
|
|
|
return self.send_command(cmd) |
567
|
|
|
|
568
|
|
|
def stop_task(self, task_id): |
|
|
|
|
569
|
|
|
cmd = self._generator.stop_task_command(task_id) |
570
|
|
|
return self.send_command(cmd) |
571
|
|
|
|
572
|
|
|
def sync_cert(self): |
|
|
|
|
573
|
|
|
cmd = self._generator.sync_cert_command() |
574
|
|
|
return self.send_command(cmd) |
575
|
|
|
|
576
|
|
|
def sync_config(self): |
|
|
|
|
577
|
|
|
cmd = self._generator.sync_config_command() |
578
|
|
|
return self.send_command(cmd) |
579
|
|
|
|
580
|
|
|
def sync_feed(self): |
|
|
|
|
581
|
|
|
cmd = self._generator.sync_feed_command() |
582
|
|
|
return self.send_command(cmd) |
583
|
|
|
|
584
|
|
|
def sync_scap(self): |
|
|
|
|
585
|
|
|
cmd = self._generator.sync_scap_command() |
586
|
|
|
return self.send_command(cmd) |
587
|
|
|
|
588
|
|
|
def test_alert(self, alert_id): |
|
|
|
|
589
|
|
|
cmd = self._generator.test_alert_command(alert_id) |
590
|
|
|
return self.send_command(cmd) |
591
|
|
|
|
592
|
|
|
def verify_agent(self, agent_id): |
|
|
|
|
593
|
|
|
cmd = self._generator.verify_agent_command(agent_id) |
594
|
|
|
return self.send_command(cmd) |
595
|
|
|
|
596
|
|
|
def verify_report_format(self, report_format_id): |
|
|
|
|
597
|
|
|
cmd = self._generator.verify_report_format_command(report_format_id) |
598
|
|
|
return self.send_command(cmd) |
599
|
|
|
|
600
|
|
|
def verify_scanner(self, scanner_id): |
|
|
|
|
601
|
|
|
cmd = self._generator.verify_scanner_command(scanner_id) |
602
|
|
|
return self.send_command(cmd) |
603
|
|
|
|
This check looks for invalid names for a range of different identifiers.
You can set regular expressions to which the identifiers must conform if the defaults do not match your requirements.
If your project includes a Pylint configuration file, the settings contained in that file take precedence.
To find out more about Pylint, please refer to their site.