gvm-tools 25.3.2__tar.gz → 25.4.0__tar.gz

{gvm_tools-25.3.2 → gvm_tools-25.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: gvm-tools
-Version: 25.3.2
+Version: 25.4.0
 Summary: Tools to control a GSM/GVM over GMP or OSP
 License: GPL-3.0-or-later
 Author: Greenbone AG

{gvm_tools-25.3.2 → gvm_tools-25.4.0}/gvmtools/__version__.py

@@ -2,4 +2,4 @@
 
 # THIS IS AN AUTOGENERATED FILE. DO NOT TOUCH!
 
-__version__ = "25.3.2"
+__version__ = "25.4.0"

{gvm_tools-25.3.2 → gvm_tools-25.4.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "poetry.core.masonry.api"
 
 [tool.poetry]
 name = "gvm-tools"
-version = "25.3.2"
+version = "25.4.0"
 authors = ["Greenbone AG <info@greenbone.net>"]
 description = "Tools to control a GSM/GVM over GMP or OSP"
 license = "GPL-3.0-or-later"

{gvm_tools-25.3.2 → gvm_tools-25.4.0}/scripts/bulk-modify-schedules.gmp.py

@@ -30,7 +30,7 @@ def check_args(args):
 
 
 def bulk_modify_schedules(gmp, filter_term, new_timezone, new_icalendar):
-    get_response = gmp.get_schedules(filter=filter_term)
+    get_response = gmp.get_schedules(filter_string=filter_term)
     schedules = get_response.findall("schedule")
 
     for schedule in schedules:

{gvm_tools-25.3.2 → gvm_tools-25.4.0}/scripts/create-cve-report-from-json.gmp.py

@@ -159,7 +159,7 @@ class ListGenerator:
                    step will make the list generation faster.
         """
         resp = self.gmp.get_info_list(
-            info_type=self.gmp.types.InfoType.CVE, filter="rows=1"
+            info_type=self.gmp.types.InfoType.CVE, filter_string="rows=1"
         )
         count = resp.find("info_count").text
 
@@ -170,7 +170,7 @@ class ListGenerator:
         while (first + step) < count:
             resp = self.gmp.get_info_list(
                 info_type=self.gmp.types.InfoType.CVE,
-                filter=f"rows={step} first={first}",
+                filter_string=f"rows={step} first={first}",
             )
             self._cpe_to_cve(resp)
             first = first + step
@@ -179,7 +179,7 @@ class ListGenerator:
         # find the rest
         resp = self.gmp.get_info_list(
             info_type=self.gmp.types.InfoType.CVE,
-            filter=f"rows={count - first} first={first}",
+            filter_string=f"rows={count - first} first={first}",
         )
         self._cpe_to_cve(resp)
         progress_bar.done()
@@ -448,7 +448,8 @@ class Parser:
 
         cpes = []
         cpe_xml = self.gmp.get_info_list(
-            info_type=gmp.types.InfoType.CPE, filter=f'rows=-1 uuid~"{cpe[0]}:"'
+            info_type=gmp.types.InfoType.CPE,
+            filter_string=f'rows=-1 uuid~"{cpe[0]}:"',
         )
         infos = cpe_xml.findall("info")
         for cpe in infos[:-1]:  # -1 because the last info tag is a wrongy. :D

{gvm_tools-25.3.2 → gvm_tools-25.4.0}/scripts/delete-overrides-by-filter.gmp.py

@@ -27,7 +27,7 @@ def check_args(args):
 
 
 def delete_overrides(gmp, filter_value):
-    filters = gmp.get_overrides(filter=filter_value)
+    filters = gmp.get_overrides(filter_string=filter_value)
 
     if not filters.xpath("override"):
         print(f"No overrides with filter: {filter_value}")

gvm_tools-25.4.0/scripts/monthly-report-gos24.10.gmp.py

@@ -0,0 +1,193 @@
+# SPDX-FileCopyrightText: 2017-2024 Greenbone AG
+#
+# SPDX-License-Identifier: GPL-3.0-or-later
+
+from argparse import ArgumentParser, Namespace, RawDescriptionHelpFormatter
+from datetime import date, datetime, timedelta
+
+from gvm.protocols.gmp import Gmp
+from terminaltables import AsciiTable
+
+
+def print_reports(
+    gmp: Gmp, from_date: date, to_date: date, reports_choice: str
+) -> None:
+    host_filter = (
+        f"rows=-1 and modified>{from_date.isoformat()} "
+        f"and created<{to_date.isoformat()}"
+    )
+
+    hosts_xml = gmp.get_hosts(filter_string=host_filter)
+
+    sum_critical = 0
+    sum_high = 0
+    sum_medium = 0
+    sum_low = 0
+
+    if reports_choice == "last":
+        table_header = [
+            "Hostname",
+            "IP",
+            "Report",
+            "Critical",
+            "High",
+            "Medium",
+            "Low",
+        ]
+    elif reports_choice == "list":
+        table_header = [
+            "Hostname",
+            "IP",
+            "Reports",
+            "Critical",
+            "High",
+            "Medium",
+            "Low",
+        ]
+    else:
+        table_header = ["Hostname", "IP", "Critical", "High", "Medium", "Low"]
+
+    table_data = [table_header]
+
+    for host in hosts_xml.xpath("asset"):
+        ip = host.xpath("name/text()")[0]
+
+        hostnames = host.xpath(
+            'identifiers/identifier/name[text()="hostname"]/../value/text()'
+        )
+
+        if len(hostnames) == 0:
+            continue
+
+        hostname = hostnames[0]
+
+        results = gmp.get_results(
+            details=False,
+            filter_string=(
+                f"rows=-1 host={ip} and severity>0.0"
+                f" and modified>{from_date.isoformat()}"
+                f" and modified<{to_date.isoformat()}"
+            ),
+        )
+
+        unique_vt_results = results.xpath(
+            "result["
+            "  not (./nvt/@oid = preceding-sibling::result/nvt/@oid)"
+            "]"
+        )
+        if len(unique_vt_results) == 0:
+            continue
+
+        low = medium = high = critical = 0
+        for result in unique_vt_results:
+            threat = result.findtext("threat")
+            if threat == "Critical":
+                critical += 1
+            elif threat == "High":
+                high += 1
+            elif threat == "Medium":
+                medium += 1
+            elif threat == "Low":
+                low += 1
+
+        sum_low += low
+        sum_medium += medium
+        sum_high += high
+        sum_critical += critical
+
+        if reports_choice == "none":
+            table_data.append([hostname, ip, critical, high, medium, low])
+        else:
+            report_host_identifiers = host.xpath(
+                "identifiers/identifier[source/deleted = 0 and"
+                '  (source/type = "Report Host"'
+                '   or source/type = "Report Host Detail")]'
+            )
+            report_ids = []
+            for identifier in report_host_identifiers:
+                mod_date = datetime.fromisoformat(
+                    identifier.findtext("modification_time")
+                ).date()
+
+                if mod_date >= to_date or mod_date < from_date:
+                    continue
+
+                report_ids.append(identifier.find("source").get("id"))
+                if reports_choice == "last":
+                    break
+
+            if reports_choice == "last":
+                table_data.append(
+                    [hostname, ip, report_ids[0], critical, high, medium, low]
+                )
+            else:
+                table_data.append(
+                    [
+                        hostname,
+                        ip,
+                        ",\n".join(report_ids) + "\n",
+                        critical,
+                        high,
+                        medium,
+                        low,
+                    ]
+                )
+
+    table = AsciiTable(table_data)
+    print(f"{table.table}\n")
+    print(
+        f"Summary of results from {from_date.isoformat()} "
+        f"to {to_date.isoformat()}"
+    )
+    print(f"Critical: {int(sum_critical)}")
+    print(f"High: {int(sum_high)}")
+    print(f"Medium: {int(sum_medium)}")
+    print(f"Low: {int(sum_low)}\n\n")
+
+
+def main(gmp: Gmp, args: Namespace) -> None:
+    # pylint: disable=undefined-variable
+
+    description_message = """
+This script will display all vulnerabilities from the hosts of the \
+reports in a given month and year.
+These must be given after the script name as plain numbers.
+
+This version is explicitly made for GOS 24.10.
+
+Example:
+    $ gvm-script --gmp-username name --gmp-password pass \
+ssh --hostname <gsm> scripts/monthly-report2.gmp.py 05 2019
+    """
+
+    parser = ArgumentParser(
+        prog=("gvm-script [...] " + args.script[0]),
+        formatter_class=RawDescriptionHelpFormatter,
+        prefix_chars="+",
+        description=description_message,
+    )
+    parser.add_argument("month", type=int, help="month of the monthly report")
+    parser.add_argument("year", type=int, help="year of the monthly report")
+    parser.add_argument(
+        "++reports",
+        choices=["none", "last", "list"],
+        default="last",
+        help=(
+            "what to show in the reports column:"
+            ' "none": do not show a reports column;'
+            ' "last": show the last report in the selected month;'
+            ' "list": show a list of reports in the selected month.'
+        ),
+    )
+    script_args, _ = parser.parse_known_args(args.script[1:])
+
+    from_date = date(script_args.year, script_args.month, 1)
+    to_date = from_date + timedelta(days=31)
+    # To have the first day in month
+    to_date = to_date.replace(day=1)
+
+    print_reports(gmp, from_date, to_date, script_args.reports)
+
+
+if __name__ == "__gmp__":
+    main(gmp, args)

{gvm_tools-25.3.2 → gvm_tools-25.4.0}/scripts/start-multiple-alerts-scan.gmp.py

@@ -137,7 +137,7 @@ def get_alerts(gmp, sender_email, recipient_email, debug=False) -> List[str]:
     alert_name = recipient_email
 
     # create alert if necessary
-    alert_object = gmp.get_alerts(filter=f"name={alert_name}")
+    alert_object = gmp.get_alerts(filter_string=f"name={alert_name}")
     alert_id = None
     alert = alert_object.xpath("alert")
     if len(alert) == 0:
@@ -170,7 +170,7 @@ should not have received it.
                 recipient_email: "to_address",
             },
         )
-        alert_object = gmp.get_alerts(filter=f"name={recipient_email}")
+        alert_object = gmp.get_alerts(filter_string=f"name={recipient_email}")
         alert = alert_object.xpath("alert")
         alert_id = alert[0].get("id", "no id found")
     else:
@@ -182,7 +182,7 @@ should not have received it.
     alert_name2 = f"{recipient_email}-2"
 
     # create second alert if necessary
-    alert_object2 = gmp.get_alerts(filter=f"name={alert_name2}")
+    alert_object2 = gmp.get_alerts(filter_string=f"name={alert_name2}")
     alert_id2 = None
     alert2 = alert_object2.xpath("alert")
     if len(alert2) == 0:
@@ -214,7 +214,7 @@ should not have received it.
                 recipient_email: "to_address",
             },
         )
-        alert_object2 = gmp.get_alerts(filter=f"name={recipient_email}")
+        alert_object2 = gmp.get_alerts(filter_string=f"name={recipient_email}")
         alert2 = alert_object2.xpath("alert")
         alert_id2 = alert2[0].get("id", "no id found")
     else:
@@ -235,7 +235,7 @@ def create_and_start_task(
     gmp, config_id, target_id, scanner_id, alerts, debug=False
 ):
     # Create the task
-    tasks = gmp.get_tasks(filter="name~ScanDoneMultipleAlert")
+    tasks = gmp.get_tasks(filter_string="name~ScanDoneMultipleAlert")
     task_name = f"ScanDoneMultipleAlert{len(tasks.xpath('tasks/@id'))}"
     task_comment = "test comment"
     res = gmp.create_task(

gvm_tools-25.3.2/scripts/monthly-report-gos24.10.gmp.py

@@ -1,118 +0,0 @@
-# SPDX-FileCopyrightText: 2017-2024 Greenbone AG
-#
-# SPDX-License-Identifier: GPL-3.0-or-later
-
-import sys
-from argparse import Namespace
-from datetime import date, timedelta
-
-from gvm.protocols.gmp import Gmp
-from terminaltables import AsciiTable
-
-
-def check_args(args: Namespace) -> None:
-    len_args = len(args.script) - 1
-    if len_args < 2:
-        message = """
-        This script will display all vulnerabilities from the hosts of the
-        reports in a given month!
-        It needs two parameters after the script name.
-        First one is the month and second one is the year.
-        Both parameters are plain numbers, so no text.
-
-        Explicitly made for GOS 24.10.
-
-        1. <month>  -- month of the monthly report
-        2. <year>   -- year of the monthly report
-
-        Example:
-            $ gvm-script --gmp-username name --gmp-password pass \
-    ssh --hostname <gsm> scripts/monthly-report2.gmp.py 05 2019
-        """
-        print(message)
-        sys.exit()
-
-
-def print_reports(gmp: Gmp, from_date: date, to_date: date) -> None:
-    host_filter = (
-        f"rows=-1 and modified>{from_date.isoformat()} "
-        f"and modified<{to_date.isoformat()}"
-    )
-
-    hosts_xml = gmp.get_hosts(filter_string=host_filter)
-
-    sum_critical = 0
-    sum_high = 0
-    sum_medium = 0
-    sum_low = 0
-    table_data = [
-        ["Hostname", "IP", "Bericht", "critical", "high", "medium", "low"]
-    ]
-
-    for host in hosts_xml.xpath("asset"):
-        ip = host.xpath("name/text()")[0]
-
-        hostnames = host.xpath(
-            'identifiers/identifier/name[text()="hostname"]/../value/text()'
-        )
-
-        if len(hostnames) == 0:
-            continue
-
-        hostname = hostnames[0]
-
-        results = gmp.get_results(
-            details=False, filter=f"host={ip} and severity>0.0"
-        )
-
-        low = int(results.xpath('count(//result/threat[text()="Low"])'))
-        sum_low += low
-
-        medium = int(results.xpath('count(//result/threat[text()="Medium"])'))
-        sum_medium += medium
-
-        high = int(results.xpath('count(//result/threat[text()="High"])'))
-        sum_high += high
-
-        critical = int(
-            results.xpath('count(//result/threat[text()="Critical"])')
-        )
-        sum_critical += critical
-
-        best_os_cpe_report_id = host.xpath(
-            'host/detail/name[text()="best_os_cpe"]/../source/@id'
-        )[0]
-
-        table_data.append(
-            [hostname, ip, best_os_cpe_report_id, critical, high, medium, low]
-        )
-
-    table = AsciiTable(table_data)
-    print(f"{table.table}\n")
-    print(
-        f"Summary of results from {from_date.isoformat()} "
-        f"to {to_date.isoformat()}"
-    )
-    print(f"Critical: {int(sum_critical)}")
-    print(f"High: {int(sum_high)}")
-    print(f"Medium: {int(sum_medium)}")
-    print(f"Low: {int(sum_low)}\n\n")
-
-
-def main(gmp: Gmp, args: Namespace) -> None:
-    # pylint: disable=undefined-variable
-
-    check_args(args)
-
-    month = int(args.script[1])
-    year = int(args.script[2])
-    from_date = date(year, month, 1)
-    to_date = from_date + timedelta(days=31)
-    # To have the first day in month
-    to_date = to_date.replace(day=1)
-
-    print_reports(gmp, from_date, to_date)
-
-
-if __name__ == "__gmp__":
-    main(gmp, args)