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
|
# -*- coding: utf-8 -*-
# SPDX-FileCopyrightText: 2021-2023 Greenbone AG
#
# SPDX-License-Identifier: AGPL-3.0-or-later
import logging
import threading
from unittest import TestCase, mock
from typing import Dict, Optional, Iterator
from ospd_openvas.messages.result import ResultMessage
from ospd_openvas.notus import Cache, Notus, NotusResultHandler
class CacheFake(Cache):
# pylint: disable=super-init-not-called
def __init__(self):
self.db = {}
self.ctx = 'foo'
def store_advisory(self, oid: str, value: Dict[str, str]):
self.db[oid] = value
def exists(self, oid: str) -> bool:
return True if self.db.get(oid, None) else False
def get_advisory(self, oid: str) -> Optional[Dict[str, str]]:
return self.db.get(oid, None)
def get_keys(self) -> Iterator[str]:
for key, _ in self.db:
yield key
class NotusTestCase(TestCase):
@mock.patch('ospd_openvas.notus.OpenvasDB')
def test_notus_retrieve(self, mock_openvasdb):
path_mock = mock.MagicMock()
redis_mock = mock.MagicMock()
mock_openvasdb.find_database_by_pattern.return_value = ('foo', 1)
mock_openvasdb.get_filenames_and_oids.return_value = [
('filename', '1.2.3')
]
notus = Notus(path_mock, Cache(redis_mock))
notus._verifier = lambda _: True # pylint: disable=protected-access
oids = [x for x in notus.get_oids()]
self.assertEqual(len(oids), 1)
@mock.patch('ospd_openvas.notus.OpenvasDB')
def test_notus_init(self, mock_openvasdb):
mock_openvasdb.find_database_by_pattern.return_value = ('foo', 1)
redis_mock = mock.MagicMock()
path_mock = mock.MagicMock()
notus = Notus(path_mock, Cache(redis_mock))
self.assertEqual(mock_openvasdb.find_database_by_pattern.call_count, 1)
self.assertEqual(notus.cache.ctx, 'foo')
@mock.patch('ospd_openvas.notus.OpenvasDB')
def test_notus_reload(self, mock_openvasdb):
path_mock = mock.MagicMock()
adv_path = mock.MagicMock()
adv_path.name = "hi"
adv_path.stem = "family"
path_mock.glob.return_value = [adv_path]
adv_path.read_bytes.return_value = b'''
{
"family": "family",
"qod_type": "remote_app",
"advisories": [
{ "oid": "12", "file_name": "aha.txt" }
]
}'''
redis_mock = mock.MagicMock()
mock_openvasdb.find_database_by_pattern.return_value = ('foo', 1)
load_into_redis = Notus(path_mock, Cache(redis_mock))
# pylint: disable=protected-access
load_into_redis._verifier = lambda _: True
load_into_redis.reload_cache()
self.assertEqual(mock_openvasdb.set_single_item.call_count, 1)
mock_openvasdb.reset_mock()
do_not_load_into_redis = Notus(path_mock, Cache(redis_mock))
# pylint: disable=protected-access
do_not_load_into_redis._verifier = lambda _: False
do_not_load_into_redis.reload_cache()
self.assertEqual(mock_openvasdb.set_single_item.call_count, 0)
def test_notus_qod_type(self):
path_mock = mock.MagicMock()
adv_path = mock.MagicMock()
adv_path.name = "hi"
adv_path.stem = "family"
path_mock.glob.return_value = [adv_path]
adv_path.read_bytes.return_value = b'''
{
"family": "family",
"advisories": [
{
"oid": "12",
"qod_type": "package_unreliable",
"severity": {
"origin": "NVD",
"date": 1505784960,
"cvss_v2": "AV:N/AC:M/Au:N/C:C/I:C/A:C",
"cvss_v3": null
}
}
]
}'''
cache_fake = CacheFake()
notus = Notus(path_mock, cache_fake)
notus._verifier = lambda _: True # pylint: disable=protected-access
notus.reload_cache()
nm = notus.get_nvt_metadata("12")
assert nm
self.assertEqual("package_unreliable", nm.get("qod_type", ""))
def test_notus_cvss_v2_v3_none(self):
path_mock = mock.MagicMock()
adv_path = mock.MagicMock()
adv_path.name = "hi"
adv_path.stem = "family"
path_mock.glob.return_value = [adv_path]
adv_path.read_bytes.return_value = b'''
{
"family": "family",
"advisories": [
{
"oid": "12",
"severity": {
"origin": "NVD",
"date": 1505784960,
"cvss_v2": "AV:N/AC:M/Au:N/C:C/I:C/A:C",
"cvss_v3": null
}
}
]
}'''
cache_fake = CacheFake()
notus = Notus(path_mock, cache_fake)
notus._verifier = lambda _: True # pylint: disable=protected-access
notus.reload_cache()
nm = notus.get_nvt_metadata("12")
assert nm
self.assertEqual(
"AV:N/AC:M/Au:N/C:C/I:C/A:C", nm.get("severity_vector", "")
)
def test_notus_fail_cases(self):
def start(self):
self.function(*self.args, **self.kwargs)
mock_report_func = mock.MagicMock(return_value=False)
logging.Logger.warning = mock.MagicMock()
notus = NotusResultHandler(mock_report_func)
res_msg = ResultMessage(
scan_id='scan_1',
host_ip='1.1.1.1',
host_name='foo',
oid='1.2.3.4.5',
value='A Vulnerability has been found',
port="42",
uri='file://foo/bar',
)
with mock.patch.object(threading.Timer, 'start', start):
notus.result_handler(res_msg)
logging.Logger.warning.assert_called_with( # pylint: disable=no-member
"Unable to report %d notus results for scan id %s.", 1, "scan_1"
)
def test_notus_success_case(self):
def start(self):
self.function(*self.args, **self.kwargs)
mock_report_func = mock.MagicMock(return_value=True)
logging.Logger.warning = mock.MagicMock()
notus = NotusResultHandler(mock_report_func)
res_msg = ResultMessage(
scan_id='scan_1',
host_ip='1.1.1.1',
host_name='foo',
oid='1.2.3.4.5',
value='A Vulnerability has been found',
port="42",
uri='file://foo/bar',
)
with mock.patch.object(threading.Timer, 'start', start):
notus.result_handler(res_msg)
logging.Logger.warning.assert_not_called() # pylint: disable=no-member
|
