-
Notifications
You must be signed in to change notification settings - Fork 90
/
check-gmp-gos22.04.gmp.py
1385 lines (1106 loc) · 40.9 KB
/
check-gmp-gos22.04.gmp.py
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
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# SPDX-FileCopyrightText: 2017-2024 Greenbone AG
#
# SPDX-License-Identifier: GPL-3.0-or-later
# pylint: disable=too-many-lines
import logging
import os
import re
import signal
import sqlite3
import sys
import tempfile
from argparse import ArgumentParser, Namespace, RawTextHelpFormatter
from datetime import datetime, timedelta, tzinfo
from decimal import Decimal
from pathlib import Path
from gvm.protocols.gmp import Gmp
from lxml import etree
__version__ = "21.7.1"
logger = logging.getLogger(__name__)
HELP_TEXT = f"""
Check-GMP Nagios Command Plugin for GOS 22.04 and older
Version {__version__} (C) 2017-2024 Greenbone AG
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
"""
NAGIOS_OK = 0
NAGIOS_WARNING = 1
NAGIOS_CRITICAL = 2
NAGIOS_UNKNOWN = 3
NAGIOS_MSG = ["OK", "WARNING", "CRITICAL", "UNKNOWN"]
MAX_RUNNING_INSTANCES = 10
class InstanceManager:
"""Class for managing instances of this plugin
All new reports will be cached in a sqlite database.
The first call with a unknown host takes longer,
because the remote gvmd/openvasmd has to generate the report.
The second call will retrieve the data from the database if the scan
duration does not differ.
Additionally this class handles all instances of check-gmp. No more than
MAX_RUNNING_INSTANCES can run simultaneously. Other instances are stopped
and wait for continuation.
"""
def __init__(self, path, parser):
"""Initialise the sqlite database.
Create it if it does not exist else connect to it.
Arguments:
path (string): Path to the database.
"""
self.cursor = None
self.con_db = None
self.db = Path(path)
self.pid = os.getpid()
# Try to read file with information about cached reports
# First check whether the file exist or not
try:
exist = self.db.is_file()
logger.debug("DB file exist?: %s ", exist)
if not exist:
if not self.db.parent.is_dir():
self.db.parent.mkdir(parents=True, exist_ok=True)
else:
self.db.touch()
# Connect to db
self.connect_db()
# Create the tables
self.cursor.execute(
"""CREATE TABLE Report(
host text,
scan_end text,
params_used text,
report text
)"""
)
self.cursor.execute(
"""CREATE TABLE Instance(
created_at text,
pid integer,
pending integer default 0
)"""
)
logger.debug("Tables created")
else:
self.connect_db()
except PermissionError:
parser.error(
f"The selected temporary database file {self.db} or the parent "
"dir has not the correct permissions."
)
@staticmethod
def _to_sql_bool(pending):
"""Replace True/False with 1/0."""
return "1" if pending else "0"
def connect_db(self):
"""Connect to the database
Simply connect to the database at location <path>
"""
try:
logger.debug("connect db: %s", self.db)
self.con_db = sqlite3.connect(str(self.db))
self.cursor = self.con_db.cursor()
logger.debug(sqlite3.sqlite_version)
except Exception as e: # pylint: disable=broad-except
logger.debug(e)
def close_db(self):
"""Close database"""
self.con_db.close()
def set_host(self, host):
"""Sets the host variable
Arguments:
host (string): Given ip or hostname of target.
"""
self.host = host
def is_old_report(self, last_scan_end, params_used):
"""Decide whether the current report is old or not
At first the last scanend and the params that were used are fetched
from the database. If no report is fetched, then True will be returned.
The next step is to compare the old and the new scanend.
If the scanends matches, then return False, because it is the same
report. Else the old report will be deleted.
Arguments:
last_scan_end (string): Last scan end of report
params_used (string): Params used for this check
Returns:
True if it is an old report or empty. False if it is the same
report.
"""
# Before we do anything here, check existing instance
# Retrieve the scan_end value
self.cursor.execute(
"SELECT scan_end, params_used FROM Report WHERE host=?",
(self.host,),
)
db_entry = self.cursor.fetchone()
logger.debug("%s %s", db_entry, last_scan_end)
if not db_entry:
return True
else:
old = parse_date(db_entry[0])
new = parse_date(last_scan_end)
logger.debug(
"Old time (from db): %s\nNew time (from rp): %s", old, new
)
if new <= old and params_used == db_entry[1]:
return False
else:
# Report is newer. Delete old entry.
logger.debug("Delete old report for host %s", self.host)
self.delete_report()
return True
def load_local_report(self):
"""Load report from local database
Select the report from the database according due the hostname or ip.
Returns:
An lxml ElementTree
"""
self.cursor.execute(
"SELECT report FROM Report WHERE host=?", (self.host,)
)
db_entry = self.cursor.fetchone()
if db_entry:
return etree.fromstring(db_entry[0])
else:
logger.debug("Report from host %s is not in the db", self.host)
def add_report(self, scan_end, params_used, report):
"""Create new entry with the lxml report
Create a string from the lxml object and add it to the database.
Additional data is the scanend and the params used.
Arguments:
scan_end (string): Scan end of the report
params_used (string): Params used for this check
report (obj): An lxml ElementTree
"""
data = etree.tostring(report)
logger.debug("add_report: %s, %s, %s", self.host, scan_end, params_used)
# Insert values
self.cursor.execute(
"INSERT INTO Report VALUES (?, ?, ?, ?)",
(self.host, scan_end, params_used, data),
)
# Save the changes
self.con_db.commit()
def delete_report(self):
"""Delete report from database"""
self.cursor.execute("DELETE FROM Report WHERE host=?", (self.host,))
# Save the changes
self.con_db.commit()
def delete_entry_with_ip(self, ip):
"""Delete report from database with given ip
Arguments:
ip (string): IP-Adress
"""
logger.debug("Delete entry with ip: %s", ip)
self.cursor.execute("DELETE FROM Report WHERE host=?", (ip,))
self.con_db.isolation_level = None
self.cursor.execute("VACUUM")
self.con_db.isolation_level = "" # see: https://github.com/CxAalto/gtfspy/commit/8d05c3c94a6d4ca3ed675d88af93def7d5053bfe # pylint: disable=line-too-long # noqa: E501
# Save the changes
self.con_db.commit()
def delete_older_entries(self, days):
"""Delete reports from database older than given days
Arguments:
days (int): Number of days in past
"""
logger.debug("Delete entries older than: %s days", days)
self.cursor.execute(
"DELETE FROM Report WHERE scan_end <= "
f'date("now", "-{days} day")'
)
self.cursor.execute("VACUUM")
# Save the changes
self.con_db.commit()
def has_entries(self, pending):
"""Return number of instance entries
Arguments:
pending (bool): True for pending instances. False for running
instances.
Returns:
The number of pending or non pending instances entries.
"""
self.cursor.execute(
"SELECT count(*) FROM Instance WHERE pending=?",
(self._to_sql_bool(pending),),
)
res = self.cursor.fetchone()
return res[0]
def check_instances(self):
"""This method checks the status of check-gmp instances.
Checks whether instances are pending or not and start instances
according to the number saved in the MAX_RUNNING_INSTANCES variable.
"""
# Need to check whether any instances are in the database that were
# killed f.e. because a restart of nagios
self.clean_orphaned_instances()
# How many processes are currently running?
number_instances = self.has_entries(pending=False)
# How many pending entries are waiting?
number_pending_instances = self.has_entries(pending=True)
logger.debug(
"check_instances: %i %i", number_instances, number_pending_instances
)
if (
number_instances < MAX_RUNNING_INSTANCES
and number_pending_instances == 0
):
# Add entry for running process and go on
logger.debug("Fall 1")
self.add_instance(pending=False)
elif (
number_instances < MAX_RUNNING_INSTANCES
and number_pending_instances > 0
):
# Change pending entries and wake them up until enough instances
# are running
logger.debug("Fall 2")
while (
number_instances < MAX_RUNNING_INSTANCES
and number_pending_instances > 0
):
pending_entries = self.get_oldest_pending_entries(
MAX_RUNNING_INSTANCES - number_instances
)
logger.debug("Oldest pending pids: %s", pending_entries)
for entry in pending_entries:
created_at = entry[0]
pid = entry[1]
# Change status to not pending and continue the process
self.update_pending_status(created_at, False)
self.start_process(pid)
# Refresh number of instances for next while loop
number_instances = self.has_entries(pending=False)
number_pending_instances = self.has_entries(pending=True)
# TODO: Check if this is really necessary
# self.add_instance(pending=False)
# if number_instances >= MAX_RUNNING_INSTANCES:
# self.stop_process(self.pid)
elif (
number_instances >= MAX_RUNNING_INSTANCES
and number_pending_instances == 0
):
# There are running enough instances and no pending instances
# Add new entry with pending status true and stop this instance
logger.debug("Fall 3")
self.add_instance(pending=True)
self.stop_process(self.pid)
elif (
number_instances >= MAX_RUNNING_INSTANCES
and number_pending_instances > 0
):
# There are running enough instances and there are min one
# pending instance
# Add new entry with pending true and stop this instance
logger.debug("Fall 4")
self.add_instance(pending=True)
self.stop_process(self.pid)
# If an entry is pending and the same params at another process is
# starting, then exit with gmp pending since data
# if self.has_pending_entries():
# Check if an pending entry is the same as this process
# If hostname
# date = datetime.now()
# end_session('GMP PENDING: since %s' % date, NAGIOS_OK)
# end_session('GMP RUNNING: since', NAGIOS_OK)
def add_instance(self, pending):
"""Add new instance entry to database
Retrieve the current time in ISO 8601 format. Create a new entry with
pending status and the dedicated pid
Arguments:
pending (bool): State of instance
"""
current_time = datetime.now().isoformat()
# Insert values
self.cursor.execute(
"INSERT INTO Instance VALUES (?, ?, ?)",
(current_time, self.pid, self._to_sql_bool(pending)),
)
# Save the changes
self.con_db.commit()
def get_oldest_pending_entries(self, number):
"""Return the oldest last entries of pending entries from database
Return:
the oldest instances with status pending limited by the variable
<number>
"""
self.cursor.execute(
"SELECT * FROM Instance WHERE pending=1 ORDER BY "
"created_at LIMIT ? ",
(number,),
)
return self.cursor.fetchall()
def update_pending_status(self, date, pending):
"""Update pending status of instance
The date variable works as a primary key for the instance table.
The entry with date get his pending status updated.
Arguments:
date (string): Date of creation for entry
pending (bool): Status of instance
"""
self.cursor.execute(
"UPDATE Instance SET pending=? WHERE created_at=?",
(self._to_sql_bool(pending), date),
)
# Save the changes
self.con_db.commit()
def delete_instance(self, pid=None):
"""Delete instance from database
If a pid different from zero is given, then delete the entry with
given pid. Else delete the entry with the pid stored in this class
instance.
Keyword Arguments:
pid (number): Process Indentificattion Number (default: {0})
"""
if not pid:
pid = self.pid
logger.debug("Delete entry with pid: %i", pid)
self.cursor.execute("DELETE FROM Instance WHERE pid=?", (pid,))
# Save the changes
self.con_db.commit()
def clean_orphaned_instances(self):
"""Delete non existing instance entries
This method check whether a pid exist on the os and if not then delete
the orphaned entry from database.
"""
self.cursor.execute("SELECT pid FROM Instance")
pids = self.cursor.fetchall()
for pid in pids:
if not self.check_pid(pid[0]):
self.delete_instance(pid[0])
def wake_instance(self):
"""Wake up a pending instance
This method is called at the end of any session from check_gmp.
Get the oldest pending entries and wake them up.
"""
# How many processes are currently running?
number_instances = self.has_entries(pending=False)
# How many pending entries are waiting?
number_pending_instances = self.has_entries(pending=True)
if (
number_instances < MAX_RUNNING_INSTANCES
and number_pending_instances > 0
):
pending_entries = self.get_oldest_pending_entries(
MAX_RUNNING_INSTANCES - number_instances
)
logger.debug(
"wake_instance: %i %i",
number_instances,
number_pending_instances,
)
for entry in pending_entries:
created_at = entry[0]
pid = entry[1]
# Change status to not pending and continue the process
self.update_pending_status(created_at, False)
self.start_process(pid)
def start_process(self, pid):
"""Continue a stopped process
Send a continue signal to the process with given pid
Arguments:
pid (int): Process Identification Number
"""
logger.debug("Continue pid: %i", pid)
os.kill(pid, signal.SIGCONT)
def stop_process(self, pid):
"""Stop a running process
Send a stop signal to the process with given pid
Arguments:
pid (int): Process Identification Number
"""
os.kill(pid, signal.SIGSTOP)
def check_pid(self, pid):
"""Check for the existence of a process.
Arguments:
pid (int): Process Identification Number
"""
try:
os.kill(pid, 0)
except OSError:
return False
else:
return True
def ping(gmp, im):
"""Checks for connectivity
This function sends the get_version command and checks whether the status
is ok or not.
"""
version = gmp.get_version()
version_status = version.xpath("@status")
if "200" in version_status:
end_session(im, "GMP OK: Ping successful", NAGIOS_OK)
else:
end_session(im, "GMP CRITICAL: Machine dead?", NAGIOS_CRITICAL)
def status(gmp, im, script_args):
"""Returns the current status of a host
This functions return the current state of a host.
Either directly over the host management or within a task.
For a task you can explicitly ask for the trend.
Otherwise the last report of the task will be filtered.
In the host management the report id in the details is taken
as report for the filter.
If the host information contains any vulnerabilities, then will the
report be filtered too. With additional parameters it is possible to add
more information about the vulnerabilities.
* DFN-Certs
* Logs
* Autofp
* Scanend
* Overrides
"""
params_used = (
f"task={script_args.task} autofp={script_args.autofp} "
f"overrides={script_args.overrides} "
f"apply_overrides={script_args.apply_overrides}"
)
if script_args.task:
task = gmp.get_tasks(
filter_string=(
"permission=any owner=any rows=1 " f'name="{script_args.task}"'
)
)
if script_args.trend:
trend = task.xpath("task/trend/text()")
if not trend:
end_session(
im, "GMP UNKNOWN: Trend is not available.", NAGIOS_UNKNOWN
)
trend = trend[0]
if trend in ["up", "more"]:
end_session(
im, f"GMP CRITICAL: Trend is {trend}.", NAGIOS_CRITICAL
)
elif trend in ["down", "same", "less"]:
end_session(im, f"GMP OK: Trend is {trend}.", NAGIOS_OK)
else:
end_session(
im,
f"GMP UNKNOWN: Trend is unknown: {trend}",
NAGIOS_UNKNOWN,
)
else:
last_report_id = task.xpath("task/last_report/report/@id")
if not last_report_id:
end_session(
im, "GMP UNKNOWN: Report is not available", NAGIOS_UNKNOWN
)
last_report_id = last_report_id[0]
last_scan_end = task.xpath(
"task/last_report/report/scan_end/text()"
)
if last_scan_end:
last_scan_end = last_scan_end[0]
else:
last_scan_end = ""
if im.is_old_report(last_scan_end, params_used):
host = script_args.hostaddress
full_report = gmp.get_report(
report_id=last_report_id,
filter_string=(
"sort-reverse=id result_hosts_only=1 min_cvss_base= "
f"min_qod= levels=hmlgd autofp={script_args.autofp} "
"notes=0 "
f"apply_overrides={script_args.apply_overrides} "
f"overrides={script_args.overrides} first=1 rows=-1 "
f"delta_states=cgns host={host}"
),
details=True,
)
im.add_report(last_scan_end, params_used, full_report)
logger.debug("Report added to db")
else:
full_report = im.load_local_report()
filter_report(
im, full_report.xpath("report/report")[0], script_args
)
def filter_report(im, report, script_args):
"""Filter out the information in a report
This function filters the results of a given report.
Arguments:
report (obj): Report as lxml ElementTree.
"""
report_id = report.xpath("@id")
if report_id:
report_id = report_id[0]
results = report.xpath("//results")
if not results:
end_session(
im, "GMP UNKNOWN: Failed to get results list", NAGIOS_UNKNOWN
)
results = results[0]
# Init variables
any_found = False
high_count = 0
medium_count = 0
low_count = 0
log_count = 0
error_count = 0
nvts = {"high": [], "medium": [], "low": [], "log": []}
all_results = results.xpath("result")
for result in all_results:
if script_args.hostaddress:
host = result.xpath("host/text()")
if not host:
end_session(
im,
"GMP UNKNOWN: Failed to parse result host",
NAGIOS_UNKNOWN,
)
if script_args.hostaddress != host[0]:
continue
any_found = True
threat = result.xpath("threat/text()")
if not threat:
end_session(
im,
"GMP UNKNOWN: Failed to parse result threat.",
NAGIOS_UNKNOWN,
)
threat = threat[0]
if threat in "High":
high_count += 1
if script_args.oid:
nvts["high"].append(retrieve_nvt_data(result))
elif threat in "Medium":
medium_count += 1
if script_args.oid:
nvts["medium"].append(retrieve_nvt_data(result))
elif threat in "Low":
low_count += 1
if script_args.oid:
nvts["low"].append(retrieve_nvt_data(result))
elif threat in "Log":
log_count += 1
if script_args.oid:
nvts["log"].append(retrieve_nvt_data(result))
else:
end_session(
im,
f"GMP UNKNOWN: Unknown result threat: {threat}",
NAGIOS_UNKNOWN,
)
errors = report.xpath("errors")
if errors:
errors = errors[0]
if script_args.hostaddress:
for error in errors.xpath("error"):
host = error.xpath("host/text()")
if script_args.hostaddress == host[0]:
error_count += 1
else:
error_count = errors.xpath("count/text()")[0]
ret = 0
if high_count > 0:
ret = NAGIOS_CRITICAL
elif medium_count > 0:
ret = NAGIOS_WARNING
if script_args.empty_as_unknown and (
not all_results or (not any_found and script_args.hostaddress)
):
ret = NAGIOS_UNKNOWN
print(
f"GMP {NAGIOS_MSG[ret]}: "
f"{str((high_count + medium_count + low_count))} "
f"vulnerabilities found - High: {str(high_count)} "
f"Medium: {str(medium_count)} Low: {str(low_count)}"
)
if not all_results:
print("Report did not contain any vulnerabilities")
elif not any_found and script_args.hostaddress:
print(
"Report did not contain vulnerabilities "
f"for IP {script_args.hostaddress}"
)
if int(error_count) > 0:
if script_args.hostaddress:
print_without_pipe(
f"Report did contain {str(error_count)} "
f"errors for IP {script_args.hostaddress}"
)
else:
print_without_pipe(f"Report did contain {error_count} errors")
if script_args.report_link:
print(
f"https://{script_args.hostname}/omp"
f"?cmd=get_report&report_id={report_id}"
)
if script_args.oid:
print_nvt_data(
nvts,
show_log=script_args.showlog,
show_ports=script_args.show_ports,
descr=script_args.descr,
dfn=script_args.dfn,
)
if script_args.scanend:
end = report.xpath("//end/text()")
end = end[0] if end else "Timestamp of scan end not given"
print(f"SCAN_END: {end}")
if script_args.details:
if script_args.hostname:
print(f"GSM_Host: {script_args.hostname}:{str(script_args.port)}")
if script_args.gmp_username:
print(f"GMP_User: {script_args.gmp_username}")
if script_args.task:
print_without_pipe(f"Task: {script_args.task}")
end_session(
im,
f"|High={str(high_count)} "
f"Medium={str(medium_count)} "
f"Low={str(low_count)}",
ret,
)
def retrieve_nvt_data(result):
"""Retrieve the nvt data out of the result object
This function parse the xml tree to find the important nvt data.
Arguments:
result (obj): Result as lxml ElementTree
Returns:
Tuple -- List with oid, name, desc, port and dfn
"""
oid = result.xpath("nvt/@oid")
name = result.xpath("nvt/name/text()")
desc = result.xpath("description/text()")
port = result.xpath("port/text()")
if oid:
oid = oid[0]
if name:
name = name[0]
if desc:
desc = desc[0]
else:
desc = ""
if port:
port = port[0]
else:
port = ""
certs = result.xpath("nvt/cert/cert_ref")
dfn_list = []
for ref in certs:
ref_type = ref.xpath("@type")[0]
ref_id = ref.xpath("@id")[0]
if ref_type in "DFN-CERT":
dfn_list.append(ref_id)
return (oid, name, desc, port, dfn_list)
def print_nvt_data(
nvts, show_log=False, show_ports=False, descr=False, dfn=False
):
"""Print nvt data
Prints for each nvt found in the array the relevant data
Arguments:
nvts (obj): Object holding all nvts
"""
for key, nvt_data in nvts.items():
if key == "log" and not show_log:
continue
for nvt in nvt_data:
print_without_pipe(f"NVT: {nvt[0]} ({key}) {nvt[1]}")
if show_ports:
print_without_pipe(f"PORT: {nvt[3]}")
if descr:
print_without_pipe(f"DESCR: {nvt[2]}")
if dfn and nvt[4]:
dfn_list = ", ".join(nvt[4])
if dfn_list:
print_without_pipe(f"DFN-CERT: {dfn_list}")
def end_session(im, msg, nagios_status):
"""End the session
Close the socket if open and print the last msg
Arguments:
msg string): Message to print
nagios_status (int): Exit status
"""
print(msg)
# Delete this instance
im.delete_instance()
# Activate some waiting instances if possible
im.wake_instance()
# Close the connection to database
im.close_db()
sys.exit(nagios_status)
def print_without_pipe(msg):
"""Prints the message, but without any pipe symbol
If any pipe symbol is in the msg string, then it will be replaced with
broken pipe symbol.
Arguments:
msg (string): Message to print
"""
if "|" in msg:
msg = msg.replace("|", "¦")
print(msg)
# ISO 8601 date time string parsing
# Copyright (c) 2007 - 2015 Michael Twomey
# Permission is hereby granted, free of charge, to any person obtaining a
# copy of this software and associated documentation files (the
# "Software"), to deal in the Software without restriction, including
# without limitation the rights to use, copy, modify, merge, publish,
# distribute, sublicense, and/or sell copies of the Software, and to
# permit persons to whom the Software is furnished to do so, subject to
# the following conditions:
# The above copyright notice and this permission notice shall be included
# in all copies or substantial portions of the Software.
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
# OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
# IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
# CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
# TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
# SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
__all__ = ["parse_date", "ParseError", "UTC"]
# Adapted from http://delete.me.uk/2005/03/iso8601.html
ISO8601_REGEX = re.compile(
r"""
(?P<year>[0-9]{4})
(
(
(-(?P<monthdash>[0-9]{1,2}))
|
(?P<month>[0-9]{2})
(?!$) # Don't allow YYYYMM
)
(
(
(-(?P<daydash>[0-9]{1,2}))
|
(?P<day>[0-9]{2})
)
(
(
(?P<separator>[ T])
(?P<hour>[0-9]{2})
(:{0,1}(?P<minute>[0-9]{2})){0,1}
(
:{0,1}(?P<second>[0-9]{1,2})
([.,](?P<second_fraction>[0-9]+)){0,1}
){0,1}
(?P<timezone>
Z
|
(
(?P<tz_sign>[-+])
(?P<tz_hour>[0-9]{2})
:{0,1}
(?P<tz_minute>[0-9]{2}){0,1}
)
){0,1}
){0,1}
)
){0,1} # YYYY-MM
){0,1} # YYYY only
$
""",
re.VERBOSE,
)
class ParseError(Exception):