File: test_scanners.py

package info (click to toggle)
python-gvm 26.7.0-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 5,220 kB
  • sloc: python: 45,844; makefile: 18
file content (424 lines) | stat: -rw-r--r-- 12,211 bytes parent folder | download
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
# SPDX-FileCopyrightText: 2024 Greenbone AG
#
# SPDX-License-Identifier: GPL-3.0-or-later

import unittest

from gvm.errors import InvalidArgument, RequiredArgument
from gvm.protocols.gmp.requests.v224 import Scanners, ScannerType


class ScannersTestCase(unittest.TestCase):

    def test_create_scanner(self):
        request = Scanners.create_scanner(
            "foo",
            "localhost",
            1234,
            scanner_type=ScannerType.OPENVAS_SCANNER_TYPE,
            credential_id="c1",
        )

        self.assertEqual(
            bytes(request),
            b"<create_scanner>"
            b"<name>foo</name>"
            b"<host>localhost</host>"
            b"<port>1234</port>"
            b"<type>2</type>"
            b'<credential id="c1"/>'
            b"</create_scanner>",
        )

    def test_create_scanner_missing_name(self):
        with self.assertRaises(RequiredArgument):
            Scanners.create_scanner(
                None,
                "localhost",
                1234,
                scanner_type=ScannerType.OPENVAS_SCANNER_TYPE,
                credential_id="c1",
            )

        with self.assertRaises(RequiredArgument):
            Scanners.create_scanner(
                "",
                "localhost",
                1234,
                scanner_type="2",
                credential_id="c1",
            )

    def test_create_scanner_missing_host(self):
        with self.assertRaises(RequiredArgument):
            Scanners.create_scanner(
                "foo",
                None,
                1234,
                scanner_type=ScannerType.OPENVAS_SCANNER_TYPE,
                credential_id="c1",
            )

        with self.assertRaises(RequiredArgument):
            Scanners.create_scanner(
                "foo",
                "",
                1234,
                scanner_type="2",
                credential_id="c1",
            )

    def test_create_scanner_missing_port(self):
        with self.assertRaises(RequiredArgument):
            Scanners.create_scanner(
                "foo",
                "localhost",
                None,
                scanner_type=ScannerType.OPENVAS_SCANNER_TYPE,
                credential_id="c1",
            )

        with self.assertRaises(RequiredArgument):
            Scanners.create_scanner(
                "foo",
                "localhost",
                "",
                scanner_type="2",
                credential_id="c1",
            )

    def test_create_scanner_missing_scanner_type(self):
        with self.assertRaises(RequiredArgument):
            Scanners.create_scanner(
                "foo",
                "localhost",
                1234,
                scanner_type=None,
                credential_id="c1",
            )

        with self.assertRaises(RequiredArgument):
            Scanners.create_scanner(
                "foo",
                "localhost",
                1234,
                scanner_type="",
                credential_id="c1",
            )

    def test_create_scanner_missing_credential_id(self):
        with self.assertRaises(RequiredArgument):
            Scanners.create_scanner(
                "foo",
                "localhost",
                1234,
                scanner_type=ScannerType.OPENVAS_SCANNER_TYPE,
                credential_id=None,
            )

        with self.assertRaises(RequiredArgument):
            Scanners.create_scanner(
                "foo",
                "localhost",
                1234,
                scanner_type="2",
                credential_id="",
            )

    def test_create_scanner_invalid_scanner_type(self):
        with self.assertRaises(InvalidArgument):
            Scanners.create_scanner(
                "foo",
                "localhost",
                1234,
                scanner_type="invalid",
                credential_id="c1",
            )

    def test_create_scanner_with_ca_pub(self):
        request = Scanners.create_scanner(
            "foo",
            "localhost",
            1234,
            scanner_type=ScannerType.OPENVAS_SCANNER_TYPE,
            credential_id="c1",
            ca_pub="foo",
        )

        self.assertEqual(
            bytes(request),
            b"<create_scanner>"
            b"<name>foo</name>"
            b"<host>localhost</host>"
            b"<port>1234</port>"
            b"<type>2</type>"
            b'<credential id="c1"/>'
            b"<ca_pub>foo</ca_pub>"
            b"</create_scanner>",
        )

    def test_create_scanner_with_comment(self):
        request = Scanners.create_scanner(
            "foo",
            "localhost",
            1234,
            scanner_type=ScannerType.OPENVAS_SCANNER_TYPE,
            credential_id="c1",
            comment="foo",
        )

        self.assertEqual(
            bytes(request),
            b"<create_scanner>"
            b"<name>foo</name>"
            b"<host>localhost</host>"
            b"<port>1234</port>"
            b"<type>2</type>"
            b'<credential id="c1"/>'
            b"<comment>foo</comment>"
            b"</create_scanner>",
        )

    def test_modify_scanner(self):
        request = Scanners.modify_scanner("s1")

        self.assertEqual(
            bytes(request),
            b'<modify_scanner scanner_id="s1"/>',
        )

    def test_modify_scanner_missing_scanner_id(self):
        with self.assertRaises(RequiredArgument):
            Scanners.modify_scanner(None)

        with self.assertRaises(RequiredArgument):
            Scanners.modify_scanner("")

    def test_modify_scanner_with_comment(self):
        request = Scanners.modify_scanner("s1", comment="foo")

        self.assertEqual(
            bytes(request),
            b'<modify_scanner scanner_id="s1">'
            b"<comment>foo</comment>"
            b"</modify_scanner>",
        )

    def test_modify_scanner_with_host(self):
        request = Scanners.modify_scanner("s1", host="foo")

        self.assertEqual(
            bytes(request),
            b'<modify_scanner scanner_id="s1">'
            b"<host>foo</host>"
            b"</modify_scanner>",
        )

    def test_modify_scanner_with_port(self):
        request = Scanners.modify_scanner("s1", port=1234)

        self.assertEqual(
            bytes(request),
            b'<modify_scanner scanner_id="s1">'
            b"<port>1234</port>"
            b"</modify_scanner>",
        )

        request = Scanners.modify_scanner("s1", port="1234")

        self.assertEqual(
            bytes(request),
            b'<modify_scanner scanner_id="s1">'
            b"<port>1234</port>"
            b"</modify_scanner>",
        )

    def test_modify_scanner_with_name(self):
        request = Scanners.modify_scanner("s1", name="foo")

        self.assertEqual(
            bytes(request),
            b'<modify_scanner scanner_id="s1">'
            b"<name>foo</name>"
            b"</modify_scanner>",
        )

    def test_modify_scanner_with_ca_pub(self):
        request = Scanners.modify_scanner("s1", ca_pub="foo")

        self.assertEqual(
            bytes(request),
            b'<modify_scanner scanner_id="s1">'
            b"<ca_pub>foo</ca_pub>"
            b"</modify_scanner>",
        )

    def test_modify_scanner_with_credential_id(self):
        request = Scanners.modify_scanner("s1", credential_id="c1")

        self.assertEqual(
            bytes(request),
            b'<modify_scanner scanner_id="s1">'
            b'<credential id="c1"/>'
            b"</modify_scanner>",
        )

    def test_modify_scanner_with_scanner_type(self):
        request = Scanners.modify_scanner(
            "s1", scanner_type=ScannerType.OPENVAS_SCANNER_TYPE
        )

        self.assertEqual(
            bytes(request),
            b'<modify_scanner scanner_id="s1">'
            b"<type>2</type>"
            b"</modify_scanner>",
        )

        request = Scanners.modify_scanner("s1", scanner_type="2")

        self.assertEqual(
            bytes(request),
            b'<modify_scanner scanner_id="s1">'
            b"<type>2</type>"
            b"</modify_scanner>",
        )

    def test_modify_scanner_invalid_scanner_type(self):
        with self.assertRaises(InvalidArgument):
            Scanners.modify_scanner("s1", scanner_type="invalid")

        with self.assertRaises(ValueError):
            Scanners.modify_scanner("s1", scanner_type="")

        with self.assertRaises(InvalidArgument):
            Scanners.modify_scanner("s1", scanner_type="-1")

        with self.assertRaises(InvalidArgument):
            Scanners.modify_scanner("s1", scanner_type=1)

    def test_get_scanners(self):
        request = Scanners.get_scanners()

        self.assertEqual(bytes(request), b"<get_scanners/>")

    def test_get_scanners_with_filter_string(self):
        request = Scanners.get_scanners(filter_string="foo=bar")

        self.assertEqual(
            bytes(request),
            b'<get_scanners filter="foo=bar"/>',
        )

    def test_get_scanners_with_filter_id(self):
        request = Scanners.get_scanners(filter_id="f1")

        self.assertEqual(
            bytes(request),
            b'<get_scanners filt_id="f1"/>',
        )

    def test_get_scanners_with_trash(self):
        request = Scanners.get_scanners(trash=True)

        self.assertEqual(
            bytes(request),
            b'<get_scanners trash="1"/>',
        )

        request = Scanners.get_scanners(trash=False)

        self.assertEqual(
            bytes(request),
            b'<get_scanners trash="0"/>',
        )

    def test_get_scanners_with_details(self):
        request = Scanners.get_scanners(details=True)

        self.assertEqual(
            bytes(request),
            b'<get_scanners details="1"/>',
        )

        request = Scanners.get_scanners(details=False)

        self.assertEqual(
            bytes(request),
            b'<get_scanners details="0"/>',
        )

    def test_get_scanner(self):
        request = Scanners.get_scanner("s1")

        self.assertEqual(
            bytes(request),
            b'<get_scanners scanner_id="s1" details="1"/>',
        )

    def test_get_scanner_missing_scanner_id(self):
        with self.assertRaises(RequiredArgument):
            Scanners.get_scanner(None)

        with self.assertRaises(RequiredArgument):
            Scanners.get_scanner("")

    def test_verify_scanner(self):
        request = Scanners.verify_scanner("s1")

        self.assertEqual(
            bytes(request),
            b'<verify_scanner scanner_id="s1"/>',
        )

    def test_verify_scanner_missing_scanner_id(self):
        with self.assertRaises(RequiredArgument):
            Scanners.verify_scanner(None)

        with self.assertRaises(RequiredArgument):
            Scanners.verify_scanner("")

    def test_clone_scanner(self):
        request = Scanners.clone_scanner("s1")

        self.assertEqual(
            bytes(request),
            b"<create_scanner><copy>s1</copy></create_scanner>",
        )

    def test_clone_scanner_missing_scanner_id(self):
        with self.assertRaises(RequiredArgument):
            Scanners.clone_scanner(None)

        with self.assertRaises(RequiredArgument):
            Scanners.clone_scanner("")

    def test_delete_scanner(self):
        request = Scanners.delete_scanner("s1")

        self.assertEqual(
            bytes(request),
            b'<delete_scanner scanner_id="s1" ultimate="0"/>',
        )

    def test_delete_scanner_ultimate(self):
        request = Scanners.delete_scanner("s1", ultimate=True)

        self.assertEqual(
            bytes(request),
            b'<delete_scanner scanner_id="s1" ultimate="1"/>',
        )

        request = Scanners.delete_scanner("s1", ultimate=False)

        self.assertEqual(
            bytes(request),
            b'<delete_scanner scanner_id="s1" ultimate="0"/>',
        )

    def test_delete_scanner_missing_scanner_id(self):
        with self.assertRaises(RequiredArgument):
            Scanners.delete_scanner(None)

        with self.assertRaises(RequiredArgument):
            Scanners.delete_scanner("")