gvm-tools 25.1.1__tar.gz → 25.2.0__tar.gz

{gvm_tools-25.1.1 → gvm_tools-25.2.0}/PKG-INFO

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

{gvm_tools-25.1.1 → gvm_tools-25.2.0}/gvmtools/__version__.py

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

{gvm_tools-25.1.1 → gvm_tools-25.2.0}/gvmtools/parser.py

@@ -16,8 +16,7 @@
 # You should have received a copy of the GNU General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
-"""Command Line Interface Parser
-"""
+"""Command Line Interface Parser"""
 
 import argparse
 import logging

{gvm_tools-25.1.1 → gvm_tools-25.2.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "poetry.core.masonry.api"
 
 [tool.poetry]
 name = "gvm-tools"
-version = "25.1.1"
+version = "25.2.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.2.0/scripts/export-hosts-csv.gmp.py

@@ -0,0 +1,180 @@
+# SPDX-FileCopyrightText: 2025 Martin Boller
+#
+# SPDX-License-Identifier: GPL-3.0-or-later
+#
+# Loosely based on other greenbone scripts
+#
+# Run with: gvm-script --gmp-username admin-user --gmp-password password socket export-hosts-csv.gmp.py <csv file> days
+# example: gvm-script --gmp-username admin --gmp-password top$ecret socket export-hosts-csv.gmp.py hosts.csv 2
+
+
+import csv
+import sys
+from argparse import ArgumentParser, Namespace, RawTextHelpFormatter
+from datetime import date, datetime, time, timedelta
+
+from gvm.protocols.gmp import Gmp
+from gvmtools.helper import error_and_exit
+
+HELP_TEXT = (
+    "This script generates a csv file with hosts (assets) "
+    "from Greenbone Vulnerability Manager.\n\n"
+    "csv file will contain:\n"
+    "IP Address, Hostname, MAC Address, Operating System, last seen, and severity\n"
+)
+
+
+def check_args(args: Namespace) -> None:
+    len_args = len(args.script) - 1
+    if len_args < 2:
+        message = """
+        This script requests all hosts <days> prior to today and exports it as a csv file.
+        It requires two parameter after the script name:
+        1. filename -- name of the csv file of the report
+        2. days     -- number of days before and until today to pull hosts information from
+        
+        Examples:
+            $ gvm-script --gmp-username username --gmp-password password socket export-hosts-csv.gmp.py <csv_file> <days>
+            $ gvm-script --gmp-username admin --gmp-password 0f6fa69b-32bb-453a-9aa4-b8c9e56b3d00 socket export-hosts-csv.gmp.py hosts.csv 4
+        """
+        print(message)
+        sys.exit()
+
+
+def parse_args(args: Namespace) -> Namespace:  # pylint: disable=unused-argument
+    """Parsing args ..."""
+
+    parser = ArgumentParser(
+        prefix_chars="+",
+        add_help=False,
+        formatter_class=RawTextHelpFormatter,
+        description=HELP_TEXT,
+    )
+
+    parser.add_argument(
+        "+h",
+        "++help",
+        action="help",
+        help="Show this help message and exit.",
+    )
+
+    parser.add_argument(
+        "csv_filename",
+        type=str,
+        help=("CSV File containing credentials"),
+    )
+
+    parser.add_argument(
+        "delta_days",
+        type=int,
+        help=("Number of days in the past to pull hosts information"),
+    )
+
+    script_args, _ = parser.parse_known_args(args)
+    return script_args
+
+
+def list_hosts(
+    gmp: Gmp, from_date: date, to_date: date, csvfilename: str
+) -> None:
+    host_filter = (
+        f"rows=-1 and modified>{from_date.isoformat()} "
+        f"and modified<{to_date.isoformat()}"
+    )
+
+    # Get the XML of hosts
+    hosts_xml = gmp.get_hosts(filter_string=host_filter)
+    host_info = []
+
+    for host in hosts_xml.xpath("asset"):
+        # ip will always be there
+        ip = host.xpath("name/text()")[0]
+        host_seendates = host.xpath("modification_time/text()")
+        host_lastseen = host_seendates[0]
+
+        # hostnames and other attributes may not be there
+        hostnames = host.xpath(
+            'identifiers/identifier/name[text()="hostname"]/../value/text()'
+        )
+        if len(hostnames) == 0:
+            hostname = ""
+            pass
+        else:
+            hostname = hostnames[0]
+
+        host_macs = host.xpath(
+            'identifiers/identifier/name[text()="MAC"]/../value/text()'
+        )
+        if len(host_macs) == 0:
+            host_mac = ""
+            pass
+        else:
+            host_mac = host_macs[0]
+
+        host_severity = host.xpath("host/severity/value/text()")
+        if len(host_severity) == 0:
+            host_severity = 0
+            pass
+        else:
+            host_severity = host_severity[0]
+
+        host_os = host.xpath(
+            'host/detail/name[text()="best_os_txt"]/../value/text()'
+        )
+        if len(host_os) == 0:
+            host_os = ""
+            pass
+        else:
+            host_os = host_os[0]
+
+        host_info.append(
+            [hostname, ip, host_mac, host_os, host_lastseen, host_severity]
+        )
+    # Write the list host_info to csv file
+    writecsv(csvfilename, host_info)
+    print(
+        f"CSV file: {csvfilename}\n"
+        f"From:     {from_date}\n"
+        f"To:       {to_date}\n"
+    )
+
+
+def writecsv(csv_filename, hostinfo: list) -> None:
+    field_names = [
+        "IP Address",
+        "Hostname",
+        "MAC Address",
+        "Operating System",
+        "Last Seen",
+        "CVSS",
+    ]
+    try:
+        with open(csv_filename, "w") as csvfile:
+            writer = csv.writer(csvfile, delimiter=",", quoting=csv.QUOTE_ALL)
+            writer.writerow(field_names)
+            writer.writerows(hostinfo)
+            csvfile.close
+    except IOError as e:
+        error_and_exit(f"Failed to write csv file: {str(e)} (exit)")
+
+
+def main(gmp: Gmp, args: Namespace) -> None:
+    # pylint: disable=undefined-variable
+    # argv[0] contains the csv file name
+    check_args(args)
+    if args.script:
+        args = args.script[1:]
+    parsed_args = parse_args(args=args)
+
+    delta_days = parsed_args.delta_days
+    # simply getting yesterday from midnight to now
+    from_date = datetime.combine(datetime.today(), time.min) - timedelta(
+        days=delta_days
+    )
+    to_date = datetime.now()
+    # get the hosts
+    list_hosts(gmp, from_date, to_date, parsed_args.csv_filename)
+
+
+if __name__ == "__gmp__":
+    main(gmp, args)

gvm_tools-25.2.0/scripts/list-hosts.gmp.py

@@ -0,0 +1,168 @@
+# SPDX-FileCopyrightText: 2025 Martin Boller
+#
+# SPDX-License-Identifier: GPL-3.0-or-later
+#
+# Loosely based on other greenbone scripts
+#
+# Run with: gvm-script --gmp-username admin-user --gmp-password password socket list-hosts.gmp.py <days>
+# example: gvm-script --gmp-username admin --gmp-password top$ecret socket list-hosts.gmp.py 2
+
+
+import sys
+from argparse import ArgumentParser, Namespace, RawTextHelpFormatter
+from datetime import date, datetime, time, timedelta
+
+from gvm.protocols.gmp import Gmp
+from gvmtools.helper import Table
+
+HELP_TEXT = (
+    "This script generates a table of hosts (assets) "
+    "from Greenbone Vulnerability Manager.\n\n"
+    "table will contain:\n"
+    "Hostname, IP Address, MAC Address, Operating System, last seen, and severity\n"
+)
+
+
+def check_args(args: Namespace) -> None:
+    len_args = len(args.script) - 1
+    if len_args < 1:
+        message = """
+        This script requests information about all hosts <days> days prior to today (included) and 
+        displays it as a table. It requires one parameter after the script name:
+        1. days -- number of days prior to today to pull hosts information from
+
+        Examples:
+            $ gvm-script --gmp-username username --gmp-password password socket list-hosts.gmp.py <days>
+            $ gvm-script --gmp-username admin --gmp-password 0f6fa69b-32bb-453a-9aa4-b8c9e56b3d00 socket list-hosts.gmp.py 4
+        """
+        print(message)
+        sys.exit()
+
+
+def parse_args(args: Namespace) -> Namespace:  # pylint: disable=unused-argument
+    """Parsing args ..."""
+
+    parser = ArgumentParser(
+        prefix_chars="+",
+        add_help=False,
+        formatter_class=RawTextHelpFormatter,
+    )
+
+    parser.add_argument(
+        "+h",
+        "++help",
+        action="help",
+        help="Show this help message and exit.",
+    )
+
+    parser.add_argument(
+        "delta_days",
+        type=int,
+        help=("Number of days in the past to pull hosts information"),
+    )
+
+    script_args, _ = parser.parse_known_args(args)
+    return script_args
+
+
+def list_hosts(gmp: Gmp, from_date: date, to_date: date) -> None:
+    host_filter = (
+        f"rows=-1 "
+        f"and modified>{from_date.isoformat()} "
+        f"and modified<{to_date.isoformat()}"
+    )
+
+    # Get the XML of hosts
+    hosts_xml = gmp.get_hosts(filter_string=host_filter)
+    heading = [
+        "#",
+        "IP Address",
+        "Hostname",
+        "MAC Address",
+        "Operating System",
+        "Last Seen",
+        "CVSS",
+    ]
+    rows = []
+    numberRows = 0
+
+    print("Listing hosts.\n" f"From: {from_date}\n" f"To:   {to_date}\n")
+
+    for host in hosts_xml.xpath("asset"):
+        # ip will always be there
+        ip = host.xpath("name/text()")[0]
+        host_seendates = host.xpath("modification_time/text()")
+        host_lastseen = host_seendates[0]
+
+        # hostnames and other attributes may not be there
+        hostnames = host.xpath(
+            'identifiers/identifier/name[text()="hostname"]/../value/text()'
+        )
+        if len(hostnames) == 0:
+            hostname = ""
+            pass
+        else:
+            hostname = hostnames[0]
+
+        host_macs = host.xpath(
+            'identifiers/identifier/name[text()="MAC"]/../value/text()'
+        )
+        if len(host_macs) == 0:
+            host_mac = ""
+            pass
+        else:
+            host_mac = host_macs[0]
+
+        host_severity = host.xpath("host/severity/value/text()")
+        if len(host_severity) == 0:
+            host_severity = "0.0"
+            pass
+        else:
+            host_severity = host_severity[0]
+
+        host_os = host.xpath(
+            'host/detail/name[text()="best_os_txt"]/../value/text()'
+        )
+        if len(host_os) == 0:
+            host_os = ""
+            pass
+        else:
+            host_os = host_os[0]
+        # Count number of hosts
+        numberRows = numberRows + 1
+        # Cast/convert to text to show in list
+        rowNumber = str(numberRows)
+        rows.append(
+            [
+                rowNumber,
+                ip,
+                hostname,
+                host_mac,
+                host_os,
+                host_lastseen,
+                host_severity,
+            ]
+        )
+
+    print(Table(heading=heading, rows=rows))
+
+
+def main(gmp: Gmp, args: Namespace) -> None:
+    # pylint: disable=undefined-variable
+    check_args(args)
+    if args.script:
+        args = args.script[1:]
+    parsed_args = parse_args(args=args)
+    delta_days = parsed_args.delta_days
+    # simply getting yesterday from midnight to today (now)
+    from_date = datetime.combine(datetime.today(), time.min) - timedelta(
+        days=delta_days
+    )
+    to_date = datetime.now()
+    # print(from_date, to_date)
+
+    list_hosts(gmp, from_date, to_date)
+
+
+if __name__ == "__gmp__":
+    main(gmp, args)

{gvm_tools-25.1.1 → gvm_tools-25.2.0}/scripts/ssv_csv.py

@@ -286,9 +286,9 @@ class SSVPrinter(CSVPrinter):
     """
 
     def __init__(self) -> None:
-        CSVPrinter.__init__(self, sep="\x1F", quot=None, eol="\n", qnl="\r")
+        CSVPrinter.__init__(self, sep="\x1f", quot=None, eol="\n", qnl="\r")
         # not permitted in SSV data
-        self._invf = re.compile("[\x00\x1F]")
+        self._invf = re.compile("[\x00\x1f]")
 
 
 class SSVWriter(CSVWriter):
@@ -297,10 +297,10 @@ class SSVWriter(CSVWriter):
     def __init__(self, file: TextIO) -> None:
         # pylint: disable=C0301
         CSVWriter.__init__(
-            self, file, sep="\x1F", quot=None, eol="\n", qnl="\r"
+            self, file, sep="\x1f", quot=None, eol="\n", qnl="\r"
         )
         # not permitted in SSV data
-        self._invf = re.compile("[\x00\x1F]")
+        self._invf = re.compile("[\x00\x1f]")
 
 
 if SSVPrinter.__doc__ is not None:
@@ -352,9 +352,9 @@ class SSVReader(object):
         if not line:
             return None
         if isinstance(line, str):
-            return self._read(line, "\n", "\r", "\x1F", "\r\n", "\x00")
+            return self._read(line, "\n", "\r", "\x1f", "\r\n", "\x00")
         if isinstance(line, bytes):
-            return self._read(line, b"\n", b"\r", b"\x1F", b"\r\n", b"\x00")
+            return self._read(line, b"\n", b"\r", b"\x1f", b"\r\n", b"\x00")
         raise TypeError()
 
 

gvm_tools-25.2.0/scripts/verify-scanners.gmp.py

@@ -0,0 +1,53 @@
+# SPDX-FileCopyrightText: 2025 Martin Boller
+#
+# SPDX-License-Identifier: GPL-3.0-or-later
+#
+# Loosely based on other greenbone scripts
+#
+# Run with: gvm-script --gmp-username admin-user --gmp-password password socket verify-scanners.gmp.py
+
+from argparse import Namespace
+
+from gvm.errors import GvmServerError
+from gvm.protocols.gmp import Gmp
+from gvmtools.helper import Table
+
+
+def main(gmp: Gmp, args: Namespace) -> None:
+    # pylint: disable=unused-argument
+
+    heading = ["#", "Name", "Id", "Host", "Version"]
+
+    rows = []
+    numberRows = 0
+
+    print("Verifying scanners.\n")
+    response_xml = gmp.get_scanners(filter_string="rows=-1")
+    scanners_xml = response_xml.xpath("scanner")
+
+    for scanner in scanners_xml:
+        # Count number of reports
+        numberRows = numberRows + 1
+        # Cast/convert to text to show in list
+        rowNumber = str(numberRows)
+        name = "".join(scanner.xpath("name/text()"))
+        scanner_id = scanner.get("id")
+        host = "".join(scanner.xpath("host/text()"))
+        if host == "":
+            host = "local scanner"
+        try:
+            status_xml = gmp.verify_scanner(str(scanner_id))
+            # pretty_print(status_xml)
+            for scanner_status in status_xml:
+                scanner_version = "".join(scanner_status.xpath("text()"))
+        except GvmServerError:
+            scanner_version = "*No Response*"
+            pass
+
+        rows.append([rowNumber, name, scanner_id, host, scanner_version])
+
+    print(Table(heading=heading, rows=rows))
+
+
+if __name__ == "__gmp__":
+    main(gmp, args)