gvm-tools 23.9.0__tar.gz → 23.11.0__tar.gz

{gvm_tools-23.9.0 → gvm_tools-23.11.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: gvm-tools
-Version: 23.9.0
+Version: 23.11.0
 Summary: Tools to control a GSM/GVM over GMP or OSP
 Home-page: https://github.com/greenbone/gvm-tools/
 License: GPL-3.0-or-later
@@ -18,6 +18,7 @@ Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Requires-Dist: python-gvm (>=23.4.2)
 Project-URL: Documentation, https://greenbone.github.io/gvm-tools/

{gvm_tools-23.9.0 → gvm_tools-23.11.0}/gvmtools/__version__.py

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

{gvm_tools-23.9.0 → gvm_tools-23.11.0}/gvmtools/cli.py

@@ -49,7 +49,7 @@ HELP_TEXT = """
       gvm-cli socket --gmp-username foo --gmp-password foo myfile.xml
 
     The protocol specifications for GMP and OSP are available at:
-      https://docs.greenbone.net/index.html#api_documentation"""
+      https://docs.greenbone.net/index.html#api_documentation"""  # noqa: E501
 
 
 def _load_infile(filename=None):

{gvm_tools-23.9.0 → gvm_tools-23.11.0}/gvmtools/config.py

@@ -84,7 +84,7 @@ class Config:
         return self._defaults
 
     def get(self, section, name):
-        if not section in self._config:
+        if section not in self._config:
             return None
 
         return self._config[section].get(name)

{gvm_tools-23.9.0 → gvm_tools-23.11.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "poetry.core.masonry.api"
 
 [tool.poetry]
 name = "gvm-tools"
-version = "23.9.0"
+version = "23.11.0"
 authors = ["Greenbone AG <info@greenbone.net>"]
 description = "Tools to control a GSM/GVM over GMP or OSP"
 license = "GPL-3.0-or-later"
@@ -12,7 +12,7 @@ readme = "README.md"
 homepage = "https://github.com/greenbone/gvm-tools/"
 repository = "https://github.com/greenbone/gvm-tools/"
 documentation = "https://greenbone.github.io/gvm-tools/"
-classifiers=[
+classifiers = [
     # Full list: https://pypi.org/pypi?%3Aaction=list_classifiers
     'Development Status :: 5 - Production/Stable',
     'License :: OSI Approved :: GNU General Public License v3 (GPLv3)',
@@ -42,7 +42,7 @@ python-gvm = ">=23.4.2"
 
 [tool.poetry.dev-dependencies]
 autohooks = ">=22.8.0"
-autohooks-plugin-pylint = ">=22.8.1"
+autohooks-plugin-ruff = ">=23.6.1"
 autohooks-plugin-black = ">=22.8.1"
 autohooks-plugin-isort = ">=22.8.0"
 pontos = ">=22.8.1"
@@ -75,7 +75,11 @@ line_length = 80
 
 [tool.autohooks]
 mode = "poetry"
-pre-commit = ['autohooks.plugins.black', 'autohooks.plugins.pylint', 'autohooks.plugins.isort']
+pre-commit = [
+    'autohooks.plugins.black',
+    'autohooks.plugins.ruff',
+    'autohooks.plugins.isort',
+]
 
 [tool.pontos.version]
 version-module-file = "gvmtools/__version__.py"

{gvm_tools-23.9.0 → gvm_tools-23.11.0}/scripts/application-detection.gmp.py

@@ -39,23 +39,42 @@ def check_args(args):
 
 
 def print_assets(gmp, appname):
-    res = gmp.get_reports()
+    res = gmp.get_reports(details=False)
 
-    hosts = res.xpath("//host")
+    reports = res.xpath("/get_reports_response/report")
+    for report in reports:
+        report_id = report.attrib["id"]
+        print_assets_for_host(gmp, appname, report_id)
+
+
+def print_assets_for_host(gmp, appname, report_id):
+    res = gmp.get_report(
+        report_id, details=True, filter_string="rows=1 result_hosts_only=0"
+    )
+
+    hosts = res.xpath("/get_reports_response/report/report/host")
 
     for host in hosts:
         ip = host.xpath("ip/text()")
+        if len(ip) == 0:
+            continue
+        else:
+            ip = ip[0]
+
         hostname = host.xpath('detail/name[text()="hostname"]/../value/text()')
         if len(hostname) == 0:
             hostname = ""
         else:
             hostname = hostname[0]
 
-        print(f"{ip} ({hostname})")
         apps = host.xpath(
             'detail/name[text() = "App"]/../value['
             f'contains(text(), "{appname}")]/text()'
         )
+        if len(apps) == 0:
+            continue
+
+        print(f"{ip} ({hostname})")
         for app in apps:
             print("\t" + app)
         print("\n")

{gvm_tools-23.9.0 → gvm_tools-23.11.0}/scripts/certbund-report.gmp.py

@@ -252,7 +252,7 @@ def main(gmp: Gmp, args: Namespace) -> None:
     _info(f"processing {len(hosts)}/{len(hostdatas)} hosts")
     for hostdata in hostdatas:
         asset = hostdata.find("asset").attrib["asset_id"]
-        if not asset in hosts:
+        if asset not in hosts:
             continue
         details: Dict[str, Optional[str]] = {}
         details["ip"] = _get_text(hostdata.find("ip"))
@@ -295,7 +295,7 @@ def main(gmp: Gmp, args: Namespace) -> None:
             # warn below
             continue
         for cbi in cbs.findall("info"):
-            if not "id" in cbi.attrib:
+            if "id" not in cbi.attrib:
                 # we have both <info id="CB-K14/1304"> (which we want)
                 # and, for some reason, <info start="1" max="10"/>
                 continue

{gvm_tools-23.9.0 → gvm_tools-23.11.0}/scripts/check-gmp.gmp.py

@@ -189,16 +189,13 @@ class InstanceManager:
             (self.host,),
         )
         db_entry = self.cursor.fetchone()
-        print(db_entry)
 
         logger.debug("%s %s", db_entry, last_scan_end)
 
         if not db_entry:
             return True
         else:
-            print(db_entry[0])
             old = parse_date(db_entry[0])
-            print(last_scan_end)
             new = parse_date(last_scan_end)
 
             logger.debug(
@@ -273,7 +270,7 @@ class InstanceManager:
         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
+        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()
 
@@ -1142,8 +1139,6 @@ def parse_date(datestring, default_timezone=UTC):
     if not isinstance(datestring, str):
         raise ParseError(f"Expecting a string {datestring}")
 
-    print(datestring)
-
     match = ISO8601_REGEX.match(datestring)
     if not match:
         raise ParseError(f"Unable to parse date string {datestring}")

{gvm_tools-23.9.0 → gvm_tools-23.11.0}/scripts/combine-reports.gmp.py

@@ -16,6 +16,8 @@
 # You should have received a copy of the GNU General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
+# ruff: noqa: E501
+
 import sys
 import time
 from argparse import Namespace
@@ -43,7 +45,7 @@ def check_args(args: Namespace) -> None:
         n. <report_n_uuid> --uuid of report to be combined
 
         Example for starting up the routine:
-            $ gvm-script --gmp-username=namessh --gmp-password=pass ssh --hostname=hostname  \
+            $ gvm-script --gmp-username=namessh --gmp-password=pass ssh --hostname=hostname \
      scripts/combine-reports.gmp.py \
     "d15a337c-56f3-4208-a462-afeb79eb03b7" \
     "303fa0a6-aa9b-43c4-bac0-66ae0b2d1698" 'first_task'

{gvm_tools-23.9.0 → gvm_tools-23.11.0}/scripts/generate-random-reports.gmp.py

@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
-# Copyright (C) 2017-2021 Greenbone AG
+# Copyright (C) 2017-2023 Greenbone AG
 #
 # SPDX-License-Identifier: GPL-3.0-or-later
 #
@@ -20,20 +20,20 @@
 
 import json
 import textwrap
-import time
 from argparse import ArgumentParser, Namespace, RawTextHelpFormatter
 from pathlib import Path
 from random import choice, gauss, randrange, seed
+from datetime import datetime, timedelta
 
 from gvm.protocols.gmp import Gmp
 from lxml import etree as e
 
 from gvmtools.helper import generate_id, generate_random_ips, generate_uuid
 
-__version__ = "0.2.0"
+__version__ = "0.3.1"
 
 HELP_TEXT = f"""
-    Random Report Generation Script {__version__} (C) 2017-2021 Greenbone AG
+    Random Report Generation Script {__version__} (C) 2017-2023 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
@@ -52,13 +52,24 @@ HELP_TEXT = f"""
     """
 
 LOREM_IPSUM = """Lorem ipsum dolor sit amet, consectetur adipiscing elit,
-sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. 
-Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut 
+sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
+Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut
 aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in
 voluptate velit esse cillum dolore eu fugiat nulla pariatur.
 Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia
 deserunt mollit anim id est laborum."""
 
+local_date_time = datetime.now()
+
+
+def calculate_timestamp(delta: int = 0) -> str:
+    return (
+        (local_date_time + timedelta(seconds=delta))
+        .astimezone()
+        .replace(microsecond=0)
+        .isoformat()
+    )
+
 
 def generate_ports(n_ports):
     protocol = ["/tcp", "/udp"]
@@ -164,17 +175,9 @@ def generate_result_elem(
     e.SubElement(own, "name").text = generate_id()
 
     elem = e.Element("modification_time")
-    e.SubElement(result_elem, "modification_time").text = (
-        time.strftime("%Y-%m-%dT%H:%M:%S%z", time.localtime(time.time()))[:-2]
-        + ":00"
-    )  # Hell of a Timeformat :D
+    e.SubElement(result_elem, "modification_time").text = calculate_timestamp(0)
     e.SubElement(result_elem, "comment").text = ""
-    e.SubElement(result_elem, "creation_time").text = (
-        time.strftime("%Y-%m-%dT%H:%M:%S%z", time.localtime(time.time() - 20))[
-            :-2
-        ]
-        + ":00"
-    )
+    e.SubElement(result_elem, "creation_time").text = calculate_timestamp(-20)
 
     host_elem = e.Element("host")
     host_elem.text = host_ip
@@ -260,18 +263,8 @@ def generate_host_elem(
     e.SubElement(host_elem, "ip").text = host_ip
     e.SubElement(host_elem, "asset", {"asset_id": host_asset}).text = ""
 
-    e.SubElement(host_elem, "start").text = (
-        time.strftime(
-            "%Y-%m-%dT%H:%M:%S%z", time.localtime(time.time() - 1000)
-        )[:-2]
-        + ":00"
-    )
-    e.SubElement(host_elem, "end").text = (
-        time.strftime("%Y-%m-%dT%H:%M:%S%z", time.localtime(time.time() - 30))[
-            :-2
-        ]
-        + ":00"
-    )
+    e.SubElement(host_elem, "start").text = calculate_timestamp(-1000)
+    e.SubElement(host_elem, "end").text = calculate_timestamp(-30)
 
     app = choice(list(data["apps"]))
     os = choice(list(data["oss"]))
@@ -304,7 +297,7 @@ def generate_host_elem(
     host_elem.append(
         generate_host_detail_elem(
             "best_os_txt",
-            list(os)[0],
+            os,
             source_name=oid,
             source_description="Host Details",
             source_type="nvt",
@@ -340,7 +333,7 @@ def generate_host_elem(
     return host_elem
 
 
-def generate_reports(task, n_reports, with_gauss, **kwargs):
+def generate_reports(task, n_reports, n_results, with_gauss, **kwargs):
     reports = []
 
     if with_gauss:
@@ -352,29 +345,65 @@ def generate_reports(task, n_reports, with_gauss, **kwargs):
         if with_gauss:
             n_results = abs(int(gauss(n_results, 2)))
 
-        report_elem = generate_report_elem(task, **kwargs)
+        report_elem = generate_report_elem(task, n_results=n_results, **kwargs)
         report_elem = e.tostring(report_elem)
         reports.append(report_elem)
 
     return reports
 
 
-def generate_data(gmp, n_tasks, **kwargs):
+def generate_target():
+    target_name = f"Random_Report_Generation_Target_{calculate_timestamp(0)}"
+    target_comment = (
+        f"Generated by Random Report Generation Script Version {__version__}."
+    )
+    target_hosts = ["198.18.0.0/24"]
+    target_port_list_id = "c7e03b6c-3bbe-11e1-a057-406186ea4fc5"
+
+    gmp.create_target(
+        name=target_name,
+        comment=target_comment,
+        hosts=target_hosts,
+        port_list_id=target_port_list_id,
+    )
+
+
+def generate_data(gmp, n_tasks, task_type, **kwargs):
+    if task_type == "scan":
+        scanner_id = "08b69003-5fc2-4037-a479-93b440211c73"
+        config_id = "085569ce-73ed-11df-83c3-002264764cea"
+        generate_target()
+        target_id = gmp.get_targets(
+            filter_string=f'"Random_Report_Generation_Target_{calculate_timestamp(0)}"'
+        ).xpath("//@id")[0]
+
     for i in range(n_tasks):
         index = f"{{0:0>{len(str(n_tasks))}}}"
-        task_name = f"Task_for_GenReport:_{index.format(i + 1)}"
+        task_name = f"Random_Report_Generation_{task_type.capitalize()}_Task_{calculate_timestamp(0)}_{index.format(i + 1)}"
+        task_comment = f"Generated by Random Report Generation Script Version {__version__}."
 
-        gmp.create_container_task(task_name)
+        gmp.create_container_task(name=task_name, comment=task_comment)
 
         task_id = gmp.get_tasks(filter_string=f"name={task_name}").xpath(
             "//@id"
         )[0]
 
+        if task_type == "scan":
+            gmp.modify_task(task_id=task_id, alterable=1)
+
         reports = generate_reports(task=(task_id, task_name), **kwargs)
 
         for report in reports[0:]:
             gmp.import_report(report, task_id=task_id, in_assets=True)
 
+        if task_type == "scan":
+            gmp.modify_task(
+                task_id=task_id,
+                target_id=target_id,
+                scanner_id=scanner_id,
+                config_id=config_id,
+            )
+
 
 def main(gmp: Gmp, args: Namespace) -> None:
     # pylint: disable=undefined-variable, line-too-long
@@ -388,8 +417,9 @@ def main(gmp: Gmp, args: Namespace) -> None:
         epilog=textwrap.dedent(
             """
         Example:
-            $ gvm-script --gmp-username name --gmp-password pass
-            ssh --hostname <gsm> scripts/gen-random-reports.gmp.py -T 5 -r 4 -R 3 --hosts 10
+            $ gvm-script --gmp-username name --gmp-password pass \
+              ssh --hostname <gsm> scripts/gen-random-reports.gmp.py \
+              -T 5 -r 4 -R 3 --hosts 10
         """
         ),
     )
@@ -473,6 +503,16 @@ def main(gmp: Gmp, args: Namespace) -> None:
         "--seed", help="RNG Seed, in case the same data should be generated."
     )
 
+    parser.add_argument(
+        "--task-type",
+        dest="task_type",
+        type=str,
+        choices=["container", "scan"],
+        default="container",
+        help="Type of Task(s) to store the generated Reports. Can either "
+        "be 'container' or 'scan', default: 'container'.",
+    )
+
     script_args = parser.parse_args(args.script_args)
 
     if not script_args.seed:
@@ -483,7 +523,7 @@ def main(gmp: Gmp, args: Namespace) -> None:
     with open(str(script_args.datafile), encoding="utf-8") as file:
         data = json.load(file)
 
-    print("\n  Generating randomized data(s)...\n")
+    print("\n  Generating randomized data...\n")
 
     generate_data(
         gmp,
@@ -496,9 +536,10 @@ def main(gmp: Gmp, args: Namespace) -> None:
         data=data,
         with_gauss=script_args.with_gauss,
         with_descriptions=script_args.with_descriptions,
+        task_type=script_args.task_type,
     )
 
-    print("\n  Generation done.\n")
+    print("\n  Generation completed.\n")
 
 
 if __name__ == "__gmp__":

gvm_tools-23.11.0/scripts/ruff.toml

@@ -0,0 +1 @@
+builtins = ["gmp", "args"]

{gvm_tools-23.9.0 → gvm_tools-23.11.0}/scripts/send-delta-emails.gmp.py

@@ -40,7 +40,8 @@ def check_args(args: Namespace) -> None:
         reports via email for selected tasks.
 
         Example for starting up the routine:
-            $ gvm-script --gmp-username name --gmp-password pass ssh --hostname <gsm> scripts/send-delta-emails.gmp.py
+            $ gvm-script --gmp-username name --gmp-password pass ssh \
+                --hostname <gsm> scripts/send-delta-emails.gmp.py
 
         The routine follows this procedure:
 
@@ -82,7 +83,7 @@ def execute_send_delta_emails(sc: sched.scheduler, **kwargs: dict) -> None:
         print(f'Processing task "{task_name}" ({task_id})...')
 
         reports = gmp.get_reports(
-            filter_string="task_id={task_id} and status=Done "
+            filter_string=f"task_id={task_id} and status=Done "
             "sort-reverse=date"
         ).xpath("report")
         print(f"  Found {str(len(reports))} report(s).")

{gvm_tools-23.9.0 → gvm_tools-23.11.0}/scripts/ssv_csv.py

@@ -54,7 +54,7 @@ __all__ = [
 
 import re
 import sys
-from typing import IO, AnyStr, List, Optional, Pattern, TextIO, Union
+from typing import IO, AnyStr, List, Optional, TextIO
 
 
 class CSVShapeError(Exception):

{gvm_tools-23.9.0 → gvm_tools-23.11.0}/scripts/start-alert-scan.gmp.py

@@ -25,7 +25,7 @@ from gvm.protocols.gmp import Gmp
 HELP_TEXT = """
         This script makes an E-Mail alert scan.
 
-        Usage examples: 
+        Usage examples:
             $ gvm-script --gmp-username name --gmp-password pass ssh --hostname
             ... start-alert-scan.gmp.py +h
             ... start-alert-scan.gmp.py ++target-name ++hosts ++ports \
@@ -114,7 +114,7 @@ def get_target(
         if port_list_name in existing_port_lists:
             counter = 0
             while True:
-                tmp_name = "{port_list_name} ({str(counter)})"
+                tmp_name = f"{port_list_name} ({str(counter)})"
                 if tmp_name in existing_port_lists:
                     counter += 1
                 else:
@@ -177,7 +177,7 @@ should not have received it.
             },
         )
 
-        alert_object = gmp.get_alerts(filter_string="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")
@@ -204,7 +204,7 @@ def create_and_start_task(
 ) -> str:
     # Create the task
     task_name = f"Alert Scan for Alert {alert_name}"
-    tasks = gmp.get_tasks(filter_string='name="{task_name}"')
+    tasks = gmp.get_tasks(filter_string=f'name="{task_name}"')
     existing_tasks = tasks.findall("task")
 
     if existing_tasks:

{gvm_tools-23.9.0 → gvm_tools-23.11.0}/scripts/start-multiple-alerts-scan.gmp.py

@@ -32,10 +32,11 @@ def check_args(args):
 
         1. <sender_email>     -- E-Mail of the sender
         2. <receiver_email>   -- E-Mail of the receiver
-        
+
                 Example:
             $ gvm-script --gmp-username name --gmp-password pass \
-ssh --hostname <gsm> scripts/start-multiple-alert-scan.gmp.py <sender_email> <receiver_email>
+ssh --hostname <gsm> scripts/start-multiple-alert-scan.gmp.py \
+<sender_email> <receiver_email>
     """
     if len_args != 2:
         print(message)

{gvm_tools-23.9.0 → gvm_tools-23.11.0}/scripts/sync-hosts.gmp.py

@@ -30,7 +30,8 @@ def check_args(args):
         This script reads host data from a csv file and sync it with the gsm.
         It needs one parameters after the script name.
 
-        1. <csv_file> - should contain a table of IP-addresses with an optional a comment
+        1. <csv_file> - should contain a table of IP-addresses with an
+                        optional a comment
 
         Example:
             $ gvm-script --gmp-username name --gmp-password pass \

{gvm_tools-23.9.0 → gvm_tools-23.11.0}/tests/scripts/__init__.py

@@ -19,7 +19,7 @@
 from importlib.util import module_from_spec, spec_from_file_location
 from pathlib import Path
 from typing import Union
-from unittest.mock import MagicMock, create_autospec, patch
+from unittest.mock import MagicMock, create_autospec
 
 from gvm.protocols.latest import Gmp
 from lxml import etree