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
|
# SPDX-FileCopyrightText: 2024 Greenbone AG
#
# SPDX-License-Identifier: GPL-3.0-or-later
import unittest
from decimal import Decimal
from gvm.errors import InvalidArgument, RequiredArgument
from gvm.protocols.gmp.requests.v224 import Notes
class NotesTestCase(unittest.TestCase):
def test_create_note(self):
request = Notes.create_note("foo", nvt_oid="oid1")
self.assertEqual(
bytes(request),
b"<create_note>"
b"<text>foo</text>"
b'<nvt oid="oid1"/>'
b"</create_note>",
)
def test_create_note_missing_text(self):
with self.assertRaises(RequiredArgument):
Notes.create_note(None, "od1")
with self.assertRaises(RequiredArgument):
Notes.create_note("", "oid1")
def test_create_note_missing_nvt_oid(self):
with self.assertRaises(RequiredArgument):
Notes.create_note("foo", None)
with self.assertRaises(RequiredArgument):
Notes.create_note("foo", "")
def test_create_note_with_hosts(self):
request = Notes.create_note("foo", nvt_oid="oid1", hosts=[])
self.assertEqual(
bytes(request),
b"<create_note>"
b"<text>foo</text>"
b'<nvt oid="oid1"/>'
b"</create_note>",
)
request = Notes.create_note("foo", nvt_oid="oid1", hosts=["h1", "h2"])
self.assertEqual(
bytes(request),
b"<create_note>"
b"<text>foo</text>"
b'<nvt oid="oid1"/>'
b"<hosts>h1,h2</hosts>"
b"</create_note>",
)
def test_create_note_with_port(self):
request = Notes.create_note("foo", nvt_oid="oid1", port="666/tcp")
self.assertEqual(
bytes(request),
b"<create_note>"
b"<text>foo</text>"
b'<nvt oid="oid1"/>'
b"<port>666/tcp</port>"
b"</create_note>",
)
def test_create_note_with_result_id(self):
request = Notes.create_note("foo", nvt_oid="oid1", result_id="r1")
self.assertEqual(
bytes(request),
b"<create_note>"
b"<text>foo</text>"
b'<nvt oid="oid1"/>'
b'<result id="r1"/>'
b"</create_note>",
)
def test_create_note_with_task_id(self):
request = Notes.create_note("foo", nvt_oid="oid1", task_id="t1")
self.assertEqual(
bytes(request),
b"<create_note>"
b"<text>foo</text>"
b'<nvt oid="oid1"/>'
b'<task id="t1"/>'
b"</create_note>",
)
def test_create_note_with_severity(self):
request = Notes.create_note("foo", nvt_oid="oid1", severity="5.5")
self.assertEqual(
bytes(request),
b"<create_note>"
b"<text>foo</text>"
b'<nvt oid="oid1"/>'
b"<severity>5.5</severity>"
b"</create_note>",
)
def test_create_note_with_days_active(self):
request = Notes.create_note("foo", nvt_oid="oid1", days_active=5)
self.assertEqual(
bytes(request),
b"<create_note>"
b"<text>foo</text>"
b'<nvt oid="oid1"/>'
b"<active>5</active>"
b"</create_note>",
)
def test_create_note_with_invalid_port(self):
with self.assertRaises(InvalidArgument):
Notes.create_note("foo", nvt_oid="oid1", port="666")
with self.assertRaises(InvalidArgument):
Notes.create_note("foo", nvt_oid="oid1", port="666/")
with self.assertRaises(InvalidArgument):
Notes.create_note("foo", nvt_oid="oid1", port="udp/666")
def test_modify_note(self):
request = Notes.modify_note("n1", "foo")
self.assertEqual(
bytes(request),
b'<modify_note note_id="n1"><text>foo</text></modify_note>',
)
def test_modify_note_missing_note_id(self):
with self.assertRaises(RequiredArgument):
Notes.modify_note(None, "foo")
with self.assertRaises(RequiredArgument):
Notes.modify_note("", "foo")
def test_modify_note_missing_text(self):
with self.assertRaises(RequiredArgument):
Notes.modify_note("n1", None)
with self.assertRaises(RequiredArgument):
Notes.modify_note("n1", "")
def test_modify_note_with_days_active(self):
request = Notes.modify_note("n1", "foo", days_active=0)
self.assertEqual(
bytes(request),
b'<modify_note note_id="n1">'
b"<text>foo</text>"
b"<active>0</active>"
b"</modify_note>",
)
request = Notes.modify_note("n1", "foo", days_active=-1)
self.assertEqual(
bytes(request),
b'<modify_note note_id="n1">'
b"<text>foo</text>"
b"<active>-1</active>"
b"</modify_note>",
)
request = Notes.modify_note("n1", "foo", days_active=600)
self.assertEqual(
bytes(request),
b'<modify_note note_id="n1">'
b"<text>foo</text>"
b"<active>600</active>"
b"</modify_note>",
)
def test_modify_note_with_port(self):
request = Notes.modify_note("n1", "foo", port="123/tcp")
self.assertEqual(
bytes(request),
b'<modify_note note_id="n1">'
b"<text>foo</text>"
b"<port>123/tcp</port>"
b"</modify_note>",
)
def test_modify_note_with_hosts(self):
request = Notes.modify_note("n1", "foo", hosts=["h1"])
self.assertEqual(
bytes(request),
b'<modify_note note_id="n1">'
b"<text>foo</text>"
b"<hosts>h1</hosts>"
b"</modify_note>",
)
request = Notes.modify_note("n1", "foo", hosts=["h1", "h2"])
self.assertEqual(
bytes(request),
b'<modify_note note_id="n1">'
b"<text>foo</text>"
b"<hosts>h1,h2</hosts>"
b"</modify_note>",
)
def test_modify_note_with_result_id(self):
request = Notes.modify_note("n1", "foo", result_id="r1")
self.assertEqual(
bytes(request),
b'<modify_note note_id="n1">'
b"<text>foo</text>"
b'<result id="r1"/>'
b"</modify_note>",
)
def test_modify_note_with_task_id(self):
request = Notes.modify_note("n1", "foo", task_id="t1")
self.assertEqual(
bytes(request),
b'<modify_note note_id="n1">'
b"<text>foo</text>"
b'<task id="t1"/>'
b"</modify_note>",
)
def test_modify_note_with_severity(self):
request = Notes.modify_note("n1", "foo", severity="5.5")
self.assertEqual(
bytes(request),
b'<modify_note note_id="n1">'
b"<text>foo</text>"
b"<severity>5.5</severity>"
b"</modify_note>",
)
request = Notes.modify_note("n1", "foo", severity=5.5)
self.assertEqual(
bytes(request),
b'<modify_note note_id="n1">'
b"<text>foo</text>"
b"<severity>5.5</severity>"
b"</modify_note>",
)
request = Notes.modify_note("n1", "foo", severity=Decimal(5.5))
self.assertEqual(
bytes(request),
b'<modify_note note_id="n1">'
b"<text>foo</text>"
b"<severity>5.5</severity>"
b"</modify_note>",
)
def test_modify_note_with_invalid_port(self):
with self.assertRaises(InvalidArgument):
Notes.modify_note("n1", "foo", port="666")
with self.assertRaises(InvalidArgument):
Notes.modify_note("n1", "foo", port="666/")
with self.assertRaises(InvalidArgument):
Notes.modify_note("n1", "foo", port="udp/666")
def test_clone_note(self):
request = Notes.clone_note("n1")
self.assertEqual(
bytes(request),
b"<create_note><copy>n1</copy></create_note>",
)
def test_clone_note_missing_note_id(self):
with self.assertRaises(RequiredArgument):
Notes.clone_note(None)
with self.assertRaises(RequiredArgument):
Notes.clone_note("")
def test_delete_note(self):
request = Notes.delete_note("n1")
self.assertEqual(
bytes(request), b'<delete_note note_id="n1" ultimate="0"/>'
)
def test_delete_note_ultimate(self):
request = Notes.delete_note("n1", ultimate=True)
self.assertEqual(
bytes(request), b'<delete_note note_id="n1" ultimate="1"/>'
)
request = Notes.delete_note("n1", ultimate=False)
self.assertEqual(
bytes(request), b'<delete_note note_id="n1" ultimate="0"/>'
)
def test_delete_note_missing_note_id(self):
with self.assertRaises(RequiredArgument):
Notes.delete_note(None)
with self.assertRaises(RequiredArgument):
Notes.delete_note("")
def test_get_notes(self):
request = Notes.get_notes()
self.assertEqual(bytes(request), b"<get_notes/>")
def test_get_notes_with_filter_string(self):
request = Notes.get_notes(filter_string="foo=bar")
self.assertEqual(bytes(request), b'<get_notes filter="foo=bar"/>')
def test_get_notes_with_filter_id(self):
request = Notes.get_notes(filter_id="f1")
self.assertEqual(bytes(request), b'<get_notes filt_id="f1"/>')
def test_get_notes_with_details(self):
request = Notes.get_notes(details=True)
self.assertEqual(bytes(request), b'<get_notes details="1"/>')
request = Notes.get_notes(details=False)
self.assertEqual(bytes(request), b'<get_notes details="0"/>')
def test_get_notes_with_result(self):
request = Notes.get_notes(result=True)
self.assertEqual(bytes(request), b'<get_notes result="1"/>')
request = Notes.get_notes(result=False)
self.assertEqual(bytes(request), b'<get_notes result="0"/>')
def test_get_note(self):
request = Notes.get_note("n1")
self.assertEqual(
bytes(request), b'<get_notes note_id="n1" details="1"/>'
)
def test_get_note_missing_note_id(self):
with self.assertRaises(RequiredArgument):
Notes.get_note(None)
with self.assertRaises(RequiredArgument):
Notes.get_note("")
|
