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
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
|
# -*- coding: utf-8 -*-
# SPDX-FileCopyrightText: 2014-2023 Greenbone AG
#
# SPDX-License-Identifier: AGPL-3.0-or-later
import time
from unittest import TestCase
from unittest.mock import patch, MagicMock
from xml.etree import ElementTree as et
from ospd.command.command import (
CheckFeed,
GetPerformance,
StartScan,
StopScan,
GetMemoryUsage,
)
from ospd.errors import OspdCommandError, OspdError
from ospd.misc import create_process
from ..helper import (
DummyWrapper,
assert_called_once,
FakeStream,
FakeDataManager,
)
class CheckFeedTestCase(TestCase):
def test_check_feed_fail(self):
daemon = DummyWrapper([])
daemon.check_feed_self_test = MagicMock(return_value=None)
cmd = CheckFeed(daemon)
request = et.fromstring('<check_feed/>')
with self.assertRaises(OspdCommandError):
cmd.handle_xml(request)
def test_check_feed(self):
daemon = DummyWrapper([])
daemon.check_feed_self_test = MagicMock(return_value={'a': '1'})
cmd = CheckFeed(daemon)
response = et.fromstring(cmd.handle_xml(et.fromstring('<check_feed/>')))
self.assertEqual(response.get('status'), '200')
self.assertEqual(response.tag, 'check_feed_response')
class GetPerformanceTestCase(TestCase):
@patch('ospd.command.command.subprocess')
def test_get_performance(self, mock_subproc):
cmd = GetPerformance(None)
mock_subproc.check_output.return_value = b'foo'
response = et.fromstring(
cmd.handle_xml(
et.fromstring(
'<get_performance start="0" end="0" titles="mem"/>'
)
)
)
self.assertEqual(response.get('status'), '200')
self.assertEqual(response.tag, 'get_performance_response')
def test_get_performance_fail_int(self):
cmd = GetPerformance(None)
request = et.fromstring(
'<get_performance start="a" end="0" titles="mem"/>'
)
with self.assertRaises(OspdCommandError):
cmd.handle_xml(request)
def test_get_performance_fail_regex(self):
cmd = GetPerformance(None)
request = et.fromstring(
'<get_performance start="0" end="0" titles="mem|bar"/>'
)
with self.assertRaises(OspdCommandError):
cmd.handle_xml(request)
def test_get_performance_fail_cmd(self):
cmd = GetPerformance(None)
request = et.fromstring(
'<get_performance start="0" end="0" titles="mem1"/>'
)
with self.assertRaises(OspdCommandError):
cmd.handle_xml(request)
class StartScanTestCase(TestCase):
def test_scan_with_vts_empty_vt_list(self):
daemon = DummyWrapper([])
cmd = StartScan(daemon)
request = et.fromstring(
'<start_scan>'
'<targets>'
'<target>'
'<hosts>localhost</hosts>'
'<ports>80, 443</ports>'
'</target>'
'</targets>'
'<scanner_params /><vt_selection />'
'</start_scan>'
)
with self.assertRaises(OspdCommandError):
cmd.handle_xml(request)
@patch("ospd.ospd.create_process")
def test_scan_with_vts(self, mock_create_process):
daemon = DummyWrapper([])
cmd = StartScan(daemon)
request = et.fromstring(
'<start_scan>'
'<targets>'
'<target>'
'<hosts>localhost</hosts>'
'<ports>80, 443</ports>'
'</target>'
'</targets>'
'<scanner_params />'
'<vt_selection>'
'<vt_single id="1.2.3.4" />'
'</vt_selection>'
'</start_scan>'
)
# With one vt, without params
response = et.fromstring(cmd.handle_xml(request))
daemon.start_queued_scans()
scan_id = response.findtext('id')
vts_collection = daemon.get_scan_vts(scan_id)
self.assertEqual(vts_collection, {'1.2.3.4': {}, 'vt_groups': []})
self.assertNotEqual(vts_collection, {'1.2.3.6': {}})
daemon.start_queued_scans()
assert_called_once(mock_create_process)
def test_scan_pop_vts(self):
daemon = DummyWrapper([])
cmd = StartScan(daemon)
request = et.fromstring(
'<start_scan>'
'<targets>'
'<target>'
'<hosts>localhost</hosts>'
'<ports>80, 443</ports>'
'</target>'
'</targets>'
'<scanner_params />'
'<vt_selection>'
'<vt_single id="1.2.3.4" />'
'</vt_selection>'
'</start_scan>'
)
# With one vt, without params
response = et.fromstring(cmd.handle_xml(request))
scan_id = response.findtext('id')
daemon.start_queued_scans()
vts_collection = daemon.get_scan_vts(scan_id)
self.assertEqual(vts_collection, {'1.2.3.4': {}, 'vt_groups': []})
self.assertRaises(KeyError, daemon.get_scan_vts, scan_id)
def test_scan_pop_ports(self):
daemon = DummyWrapper([])
cmd = StartScan(daemon)
request = et.fromstring(
'<start_scan>'
'<targets>'
'<target>'
'<hosts>localhost</hosts>'
'<ports>80, 443</ports>'
'</target>'
'</targets>'
'<scanner_params />'
'<vt_selection>'
'<vt_single id="1.2.3.4" />'
'</vt_selection>'
'</start_scan>'
)
# With one vt, without params
response = et.fromstring(cmd.handle_xml(request))
daemon.start_queued_scans()
scan_id = response.findtext('id')
ports = daemon.scan_collection.get_ports(scan_id)
self.assertEqual(ports, '80, 443')
self.assertRaises(KeyError, daemon.scan_collection.get_ports, scan_id)
@patch("ospd.ospd.create_process")
def test_scan_without_vts(self, mock_create_process):
daemon = DummyWrapper([])
cmd = StartScan(daemon)
# With out vts
request = et.fromstring(
'<start_scan>'
'<targets>'
'<target>'
'<hosts>localhost</hosts>'
'<ports>80, 443</ports>'
'</target>'
'</targets>'
'<scanner_params />'
'</start_scan>'
)
response = et.fromstring(cmd.handle_xml(request))
daemon.start_queued_scans()
scan_id = response.findtext('id')
self.assertEqual(daemon.get_scan_vts(scan_id), {})
assert_called_once(mock_create_process)
def test_scan_with_vts_and_param_missing_vt_param_id(self):
daemon = DummyWrapper([])
cmd = StartScan(daemon)
# Raise because no vt_param id attribute
request = et.fromstring(
'<start_scan>'
'<targets>'
'<target>'
'<hosts>localhost</hosts>'
'<ports>80, 443</ports>'
'</target>'
'</targets>'
'<scanner_params />'
'<vt_selection>'
'<vt_single id="1234"><vt_value>200</vt_value></vt_single>'
'</vt_selection>'
'</start_scan>'
)
with self.assertRaises(OspdError):
cmd.handle_xml(request)
@patch("ospd.ospd.create_process")
def test_scan_with_vts_and_param(self, mock_create_process):
daemon = DummyWrapper([])
cmd = StartScan(daemon)
# No error
request = et.fromstring(
'<start_scan>'
'<targets>'
'<target>'
'<hosts>localhost</hosts>'
'<ports>80, 443</ports>'
'</target>'
'</targets>'
'<scanner_params />'
'<vt_selection>'
'<vt_single id="1234">'
'<vt_value id="ABC">200</vt_value>'
'</vt_single>'
'</vt_selection>'
'</start_scan>'
)
response = et.fromstring(cmd.handle_xml(request))
daemon.start_queued_scans()
scan_id = response.findtext('id')
self.assertEqual(
daemon.get_scan_vts(scan_id),
{'1234': {'ABC': '200'}, 'vt_groups': []},
)
daemon.start_queued_scans()
assert_called_once(mock_create_process)
def test_scan_with_vts_and_param_missing_vt_group_filter(self):
daemon = DummyWrapper([])
cmd = StartScan(daemon)
# Raise because no vtgroup filter attribute
request = et.fromstring(
'<start_scan>'
'<targets>'
'<target>'
'<hosts>localhost</hosts>'
'<ports>80, 443</ports>'
'</target>'
'</targets>'
'<scanner_params />'
'<vt_selection><vt_group/></vt_selection>'
'</start_scan>'
)
daemon.start_queued_scans()
with self.assertRaises(OspdError):
cmd.handle_xml(request)
@patch("ospd.ospd.create_process")
def test_scan_with_vts_and_param_with_vt_group_filter(
self, mock_create_process
):
daemon = DummyWrapper([])
cmd = StartScan(daemon)
# No error
request = et.fromstring(
'<start_scan>'
'<targets>'
'<target>'
'<hosts>localhost</hosts>'
'<ports>80, 443</ports>'
'</target>'
'</targets>'
'<scanner_params />'
'<vt_selection>'
'<vt_group filter="a"/>'
'</vt_selection>'
'</start_scan>'
)
response = et.fromstring(cmd.handle_xml(request))
daemon.start_queued_scans()
scan_id = response.findtext('id')
self.assertEqual(daemon.get_scan_vts(scan_id), {'vt_groups': ['a']})
assert_called_once(mock_create_process)
@patch("ospd.ospd.create_process")
@patch("ospd.command.command.logger")
def test_scan_ignore_multi_target(self, mock_logger, mock_create_process):
daemon = DummyWrapper([])
cmd = StartScan(daemon)
request = et.fromstring(
'<start_scan parallel="100a">'
'<targets>'
'<target>'
'<hosts>localhosts</hosts>'
'<ports>22</ports>'
'</target>'
'</targets>'
'<scanner_params />'
'</start_scan>'
)
cmd.handle_xml(request)
daemon.start_queued_scans()
assert_called_once(mock_logger.warning)
assert_called_once(mock_create_process)
def test_max_queued_scans_reached(self):
daemon = DummyWrapper([])
daemon.max_queued_scans = 1
cmd = StartScan(daemon)
request = et.fromstring(
'<start_scan parallel="100a">'
'<targets>'
'<target>'
'<hosts>localhosts</hosts>'
'<ports>22</ports>'
'</target>'
'</targets>'
'<scanner_params />'
'</start_scan>'
)
# create first scan
response = et.fromstring(cmd.handle_xml(request))
scan_id_1 = response.findtext('id')
with self.assertRaises(OspdCommandError):
cmd.handle_xml(request)
daemon.scan_collection.remove_file_pickled_scan_info(scan_id_1)
@patch("ospd.ospd.create_process")
@patch("ospd.command.command.logger")
def test_scan_use_legacy_target_and_port(
self, mock_logger, mock_create_process
):
daemon = DummyWrapper([])
daemon.scan_collection.datamanager = FakeDataManager()
cmd = StartScan(daemon)
request = et.fromstring(
'<start_scan target="localhost" ports="22">'
'<scanner_params />'
'</start_scan>'
)
response = et.fromstring(cmd.handle_xml(request))
daemon.start_queued_scans()
scan_id = response.findtext('id')
self.assertIsNotNone(scan_id)
self.assertEqual(daemon.get_scan_host(scan_id), 'localhost')
self.assertEqual(daemon.get_scan_ports(scan_id), '22')
assert_called_once(mock_logger.warning)
assert_called_once(mock_create_process)
class StopCommandTestCase(TestCase):
@patch("ospd.ospd.os")
@patch("ospd.ospd.create_process")
def test_stop_scan(self, mock_create_process, mock_os):
mock_process = mock_create_process.return_value
mock_process.is_alive.return_value = True
mock_process.pid = "foo"
fs = FakeStream()
daemon = DummyWrapper([])
daemon.scan_collection.datamanager = FakeDataManager()
request = (
'<start_scan>'
'<targets>'
'<target>'
'<hosts>localhosts</hosts>'
'<ports>22</ports>'
'</target>'
'</targets>'
'<scanner_params />'
'</start_scan>'
)
daemon.handle_command(request, fs)
response = fs.get_response()
daemon.start_queued_scans()
assert_called_once(mock_create_process)
assert_called_once(mock_process.start)
scan_id = response.findtext('id')
request = et.fromstring(f'<stop_scan scan_id="{scan_id}" />')
cmd = StopScan(daemon)
cmd.handle_xml(request)
assert_called_once(mock_process.terminate)
mock_os.getpgid.assert_called_with('foo')
def test_unknown_scan_id(self):
daemon = DummyWrapper([])
cmd = StopScan(daemon)
request = et.fromstring('<stop_scan scan_id="foo" />')
with self.assertRaises(OspdCommandError):
cmd.handle_xml(request)
def test_missing_scan_id(self):
request = et.fromstring('<stop_scan />')
cmd = StopScan(None)
with self.assertRaises(OspdCommandError):
cmd.handle_xml(request)
class GetMemoryUsageTestCase(TestCase):
def test_with_main_process_only(self):
cmd = GetMemoryUsage(None)
request = et.fromstring('<get_memory_usage />')
response = et.fromstring(cmd.handle_xml(request))
processes_element = response.find('processes')
process_elements = processes_element.findall('process')
self.assertTrue(len(process_elements), 1)
main_process_element = process_elements[0]
rss_element = main_process_element.find('rss')
vms_element = main_process_element.find('vms')
shared_element = main_process_element.find('shared')
self.assertIsNotNone(rss_element)
self.assertIsNotNone(rss_element.text)
self.assertIsNotNone(vms_element)
self.assertIsNotNone(vms_element.text)
self.assertIsNotNone(shared_element)
self.assertIsNotNone(shared_element.text)
def test_with_subprocess(self):
cmd = GetMemoryUsage(None)
def foo(): # pylint: disable=blacklisted-name
time.sleep(60)
create_process(foo, args=[])
request = et.fromstring('<get_memory_usage />')
response = et.fromstring(cmd.handle_xml(request))
processes_element = response.find('processes')
process_elements = processes_element.findall('process')
self.assertTrue(len(process_elements), 2)
for process_element in process_elements:
rss_element = process_element.find('rss')
vms_element = process_element.find('vms')
shared_element = process_element.find('shared')
self.assertIsNotNone(rss_element)
self.assertIsNotNone(rss_element.text)
self.assertIsNotNone(vms_element)
self.assertIsNotNone(vms_element.text)
self.assertIsNotNone(shared_element)
self.assertIsNotNone(shared_element.text)
def test_with_subsubprocess(self):
cmd = GetMemoryUsage(None)
def bar(): # pylint: disable=blacklisted-name
create_process(foo, args=[])
def foo(): # pylint: disable=blacklisted-name
time.sleep(60)
create_process(bar, args=[])
request = et.fromstring('<get_memory_usage />')
response = et.fromstring(cmd.handle_xml(request))
processes_element = response.find('processes')
process_elements = processes_element.findall('process')
# sub-sub-processes aren't listed
self.assertTrue(len(process_elements), 2)
for process_element in process_elements:
rss_element = process_element.find('rss')
vms_element = process_element.find('vms')
shared_element = process_element.find('shared')
self.assertIsNotNone(rss_element)
self.assertIsNotNone(rss_element.text)
self.assertIsNotNone(vms_element)
self.assertIsNotNone(vms_element.text)
self.assertIsNotNone(shared_element)
self.assertIsNotNone(shared_element.text)
|
