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
|
# -*- coding: utf-8 -*-
# SPDX-FileCopyrightText: 2014-2023 Greenbone AG
#
# SPDX-License-Identifier: AGPL-3.0-or-later
"""Helper classes for parsing and creating OSP XML requests and responses"""
from typing import Dict, Union, List, Any
from xml.etree.ElementTree import SubElement, Element, XMLPullParser
from ospd.errors import OspdError
class RequestParser:
def __init__(self):
self._parser = XMLPullParser(['start', 'end'])
self._root_element = None
def has_ended(self, data: bytes) -> bool:
self._parser.feed(data)
for event, element in self._parser.read_events():
if event == 'start' and self._root_element is None:
self._root_element = element
elif event == 'end' and self._root_element is not None:
if element.tag == self._root_element.tag:
return True
return False
class OspRequest:
@staticmethod
def process_vts_params(
scanner_vts: Element,
) -> Dict[str, Union[Dict[str, str], List]]:
"""Receive an XML object with the Vulnerability Tests an their
parameters to be use in a scan and return a dictionary.
@param: XML element with vt subelements. Each vt has an
id attribute. Optional parameters can be included
as vt child.
Example form:
<vt_selection>
<vt_single id='vt1' />
<vt_single id='vt2'>
<vt_value id='param1'>value</vt_value>
</vt_single>
<vt_group filter='family=debian'/>
<vt_group filter='family=general'/>
</vt_selection>
@return: Dictionary containing the vts attribute and subelements,
like the VT's id and VT's parameters.
Example form:
{'vt1': {},
'vt2': {'value_id': 'value'},
'vt_groups': ['family=debian', 'family=general']}
"""
vt_selection = {} # type: Dict
filters = []
for vt in scanner_vts:
if vt.tag == 'vt_single':
vt_id = vt.attrib.get('id')
vt_selection[vt_id] = {}
for vt_value in vt:
if not vt_value.attrib.get('id'):
raise OspdError(
'Invalid VT preference. No attribute id'
)
vt_value_id = vt_value.attrib.get('id')
vt_value_value = vt_value.text if vt_value.text else ''
vt_selection[vt_id][vt_value_id] = vt_value_value
if vt.tag == 'vt_group':
vts_filter = vt.attrib.get('filter', None)
if vts_filter is None:
raise OspdError('Invalid VT group. No filter given.')
filters.append(vts_filter)
vt_selection['vt_groups'] = filters
return vt_selection
@staticmethod
def process_credentials_elements(cred_tree: Element) -> Dict:
"""Receive an XML object with the credentials to run
a scan against a given target.
@param:
<credentials>
<credential type="up" service="ssh" port="22">
<username>scanuser</username>
<password>mypass</password>
</credential>
<credential type="up" service="smb">
<username>smbuser</username>
<password>mypass</password>
</credential>
</credentials>
@return: Dictionary containing the credentials for a given target.
Example form:
{'ssh': {'type': type,
'port': port,
'username': username,
'password': pass,
},
'smb': {'type': type,
'username': username,
'password': pass,
},
}
"""
credentials = {} # type: Dict
for credential in cred_tree:
service = credential.attrib.get('service')
credentials[service] = {}
credentials[service]['type'] = credential.attrib.get('type')
if service == 'ssh':
credentials[service]['port'] = credential.attrib.get('port')
for param in credential:
credentials[service][param.tag] = (
param.text if param.text else ""
)
return credentials
@staticmethod
def process_alive_test_methods(
alive_test_tree: Element, options: Dict
) -> None:
"""Receive an XML object with the alive test methods to run
a scan with. Methods are added to the options Dict.
@param
<alive_test_methods>
</icmp>boolean(1 or 0)</icmp>
</tcp_ack>boolean(1 or 0)</tcp_ack>
</tcp_syn>boolean(1 or 0)</tcp_syn>
</arp>boolean(1 or 0)</arp>
</consider_alive>boolean(1 or 0)</consider_alive>
</alive_test_methods>
"""
for child in alive_test_tree:
if child.tag == 'icmp':
if child.text is not None:
options['icmp'] = child.text
if child.tag == 'tcp_ack':
if child.text is not None:
options['tcp_ack'] = child.text
if child.tag == 'tcp_syn':
if child.text is not None:
options['tcp_syn'] = child.text
if child.tag == 'arp':
if child.text is not None:
options['arp'] = child.text
if child.tag == 'consider_alive':
if child.text is not None:
options['consider_alive'] = child.text
@classmethod
def process_target_element(cls, scanner_target: Element) -> Dict:
"""Receive an XML object with the target, ports and credentials to run
a scan against.
Arguments:
Single XML target element. The target has <hosts> and <ports>
subelements. Hosts can be a single host, a host range, a
comma-separated host list or a network address.
<ports> and <credentials> are optional. Therefore each
ospd-scanner should check for a valid ones if needed.
Example form:
<target>
<hosts>192.168.0.0/24</hosts>
<ports>22</ports>
<credentials>
<credential type="up" service="ssh" port="22">
<username>scanuser</username>
<password>mypass</password>
</credential>
<credential type="up" service="smb">
<username>smbuser</username>
<password>mypass</password>
</credential>
</credentials>
<alive_test></alive_test>
<alive_test_ports></alive_test_ports>
<reverse_lookup_only>1</reverse_lookup_only>
<reverse_lookup_unify>0</reverse_lookup_unify>
</target>
Return:
A Dict hosts, port, {credentials}, exclude_hosts, options].
Example form:
{
'hosts': '192.168.0.0/24',
'port': '22',
'credentials': {'smb': {'type': type,
'port': port,
'username': username,
'password': pass,
}
},
'exclude_hosts': '',
'finished_hosts': '',
'options': {'alive_test': 'ALIVE_TEST_CONSIDER_ALIVE',
'alive_test_ports: '22,80,123',
'reverse_lookup_only': '1',
'reverse_lookup_unify': '0',
},
}
"""
if scanner_target:
exclude_hosts = ''
finished_hosts = ''
ports = ''
hosts = None
credentials = {} # type: Dict
options = {}
for child in scanner_target:
if child.tag == 'hosts':
hosts = child.text
if child.tag == 'exclude_hosts':
exclude_hosts = child.text
if child.tag == 'finished_hosts':
finished_hosts = child.text
if child.tag == 'ports':
ports = child.text
if child.tag == 'credentials':
credentials = cls.process_credentials_elements(child)
if child.tag == 'alive_test_methods':
options['alive_test_methods'] = '1'
cls.process_alive_test_methods(child, options)
if child.tag == 'alive_test':
options['alive_test'] = child.text
if child.tag == 'alive_test_ports':
options['alive_test_ports'] = child.text
if child.tag == 'reverse_lookup_unify':
options['reverse_lookup_unify'] = child.text
if child.tag == 'reverse_lookup_only':
options['reverse_lookup_only'] = child.text
if hosts:
return {
'hosts': hosts,
'ports': ports,
'credentials': credentials,
'exclude_hosts': exclude_hosts,
'finished_hosts': finished_hosts,
'options': options,
}
else:
raise OspdError('No target to scan')
class OspResponse:
@staticmethod
def create_scanner_params_xml(scanner_params: Dict[str, Any]) -> Element:
"""Returns the OSP Daemon's scanner params in xml format."""
scanner_params_xml = Element('scanner_params')
for param_id, param in scanner_params.items():
param_xml = SubElement(scanner_params_xml, 'scanner_param')
for name, value in [('id', param_id), ('type', param['type'])]:
param_xml.set(name, value)
for name, value in [
('name', param['name']),
('description', param['description']),
('default', param['default']),
('mandatory', param['mandatory']),
]:
elem = SubElement(param_xml, name)
elem.text = str(value)
return scanner_params_xml
|
