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

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

@@ -1,11 +1,11 @@
 Metadata-Version: 2.3
 Name: gvm-tools
-Version: 25.1.1
+Version: 25.3.0
 Summary: Tools to control a GSM/GVM over GMP or OSP
 License: GPL-3.0-or-later
 Author: Greenbone AG
 Author-email: info@greenbone.net
-Requires-Python: >=3.9,<4.0
+Requires-Python: >=3.9.2,<4.0.0
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Environment :: Console
 Classifier: Intended Audience :: Developers
@@ -14,11 +14,11 @@ Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
 Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
 Classifier: Operating System :: OS Independent
 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: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.9
 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-25.1.1 → gvm_tools-25.3.0}/gvmtools/__version__.py

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

{gvm_tools-25.1.1 → gvm_tools-25.3.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.3.0/pyproject.toml

@@ -0,0 +1,177 @@
+[build-system]
+requires = ["poetry-core>=1.0.0"]
+build-backend = "poetry.core.masonry.api"
+
+[tool.poetry]
+name = "gvm-tools"
+version = "25.3.0"
+authors = ["Greenbone AG <info@greenbone.net>"]
+description = "Tools to control a GSM/GVM over GMP or OSP"
+license = "GPL-3.0-or-later"
+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 = [
+    # Full list: https://pypi.org/pypi?%3Aaction=list_classifiers
+    'Development Status :: 5 - Production/Stable',
+    'License :: OSI Approved :: GNU General Public License v3 (GPLv3)',
+    'Environment :: Console',
+    'Intended Audience :: Developers',
+    'Intended Audience :: System Administrators',
+    'Programming Language :: Python :: 3.9',
+    'Programming Language :: Python :: 3.10',
+    'Programming Language :: Python :: 3.11',
+    'Programming Language :: Python :: 3.12',
+    'Operating System :: OS Independent',
+    'Topic :: Software Development :: Libraries :: Python Modules',
+]
+packages = [
+    { include = "gvmtools" },
+    { include = "tests", format = "sdist" },
+    { include = "scripts", format = "sdist" },
+]
+
+[tool.poetry.scripts]
+gvm-pyshell = "gvmtools.pyshell:main"
+gvm-cli = "gvmtools.cli:main"
+gvm-script = "gvmtools.script:main"
+
+[tool.poetry.dependencies]
+python = "^3.9.2"
+python-gvm = ">=23.4.2"
+
+[tool.poetry.group.dev.dependencies]
+autohooks = ">=22.8.0"
+autohooks-plugin-ruff = ">=23.6.1"
+autohooks-plugin-black = ">=22.8.1"
+pontos = ">=22.8.1"
+sphinx = ">=5.3.0"
+coverage = ">=7.2"
+rope = ">=1.9.0"
+furo = ">=2023.3.27"
+sphinx-autobuild = ">=2021.3.14"
+myst-parser = ">=2.0.0"
+git-cliff = "^2.8.0"
+
+[tool.black]
+line-length = 80
+target-version = ['py39', 'py310', 'py311', 'py312']
+exclude = '''
+/(
+    \.git
+  | \.venv
+  | \.github
+  | \.vscode
+  | _build
+  | build
+  | dist
+  | docs
+)/
+'''
+
+[tool.autohooks]
+mode = "poetry"
+pre-commit = ['autohooks.plugins.black', 'autohooks.plugins.ruff']
+
+[tool.ruff]
+line-length = 80
+target-version = "py39"
+
+[tool.ruff.lint]
+extend-select = ["I", "PLE", "PLW"]
+
+[tool.coverage.run]
+omit = ["tests/*"]
+source = ["gvmtools", "scripts"]
+
+[tool.pontos.version]
+version-module-file = "gvmtools/__version__.py"
+
+[tool.git-cliff.changelog]
+# template for the changelog header
+header = """
+# Changelog\n
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).\n
+"""
+# template for the changelog body
+# https://keats.github.io/tera/docs/#introduction
+body = """
+{%- macro remote_url() -%}
+  https://github.com/{{ remote.github.owner }}/{{ remote.github.repo }}
+{%- endmacro -%}
+
+{% if version -%}
+    ## [{{ version | trim_start_matches(pat="v") }}] - {{ timestamp | date(format="%Y-%m-%d") }}
+{% else -%}
+    ## [Unreleased]
+{% endif -%}
+
+{% for group, commits in commits | group_by(attribute="group") %}
+    ### {{ group | upper_first }}
+    {% for commit in commits %}
+        - {{ commit.message | split(pat="\n") | first | upper_first | trim }}\
+            {% if commit.remote.username %} by [@{{ commit.remote.username }}](https://github.com/{{ commit.remote.username }}){%- endif -%}
+            {% if commit.remote.pr_number %} in \
+            [#{{ commit.remote.pr_number }}]({{ self::remote_url() }}/pull/{{ commit.remote.pr_number }}) \
+            {% elif commit.id %} in \
+            [{{ commit.id | truncate(length=7, end="") }}]({{ self::remote_url() }}/commit/{{ commit.id }})\
+            {%- endif -%}
+    {% endfor %}
+{% endfor -%}
+"""
+# template for the changelog footer
+footer = """
+{%- macro remote_url() -%}
+  https://github.com/{{ remote.github.owner }}/{{ remote.github.repo }}
+{%- endmacro -%}
+
+{% for release in releases %}
+    {% if release.version -%}
+        {% if release.previous.version -%}
+            [{{ release.version | trim_start_matches(pat="v") }}]: \
+                {{ self::remote_url() }}/compare/{{ release.previous.version }}..{{ release.version }}
+        {% endif -%}
+    {% else -%}
+        [unreleased]: {{ self::remote_url() }}/compare/{{ release.previous.version }}..HEAD
+    {% endif -%}
+{%- endfor -%}
+"""
+# remove the leading and trailing whitespace from the templates
+trim = true
+
+[tool.git-cliff.git]
+# parse the commits based on https://www.conventionalcommits.org
+conventional_commits = true
+# filter out the commits that are not following the conventional commits format
+filter_unconventional = false
+# process each line of a commit as an individual commit
+split_commits = false
+# regex for preprocessing the commit messages
+commit_preprocessors = [
+    # remove issue numbers from commits
+    { pattern = '\((\w+\s)?#([0-9]+)\)', replace = "" },
+]
+# regex for parsing and grouping commits
+commit_parsers = [
+    { message = "^[a|A]dd", group = "<!-- 1 -->:sparkles: Added" },
+    { message = "^[c|C]hange", group = "<!-- 2 -->:construction_worker: Changed" },
+    { message = "^[f|F]ix", group = "<!-- 3 -->:bug: Bug Fixes" },
+    { message = "^[r|R]emove", group = "<!-- 4 -->:fire: Removed" },
+    { message = "^[d|D]rop", group = "<!-- 4 -->:fire: Removed" },
+    { message = "^[d|D]oc", group = "<!-- 5 -->:books: Documentation" },
+    { message = "^[t|T]est", group = "<!-- 6 -->:white_check_mark: Testing" },
+    { message = "^[c|C]hore", group = "<!-- 7 -->:wrench: Miscellaneous" },
+    { message = "^[c|C]i", group = "<!-- 7 -->️:wrench: Miscellaneous" },
+    { message = "^[m|M]isc", group = "<!-- 7 -->:wrench: Miscellaneous" },
+    { message = "^[d|D]eps", group = "<!-- 8 -->:ship: Dependencies" },
+]
+# filter out the commits that are not matched by commit parsers
+filter_commits = true
+# sort the tags topologically
+topo_order = false
+# sort the commits inside sections by oldest/newest order
+sort_commits = "oldest"

gvm_tools-25.3.0/scripts/export-certificates.gmp.py

@@ -0,0 +1,160 @@
+# 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
+from argparse import ArgumentParser, Namespace, RawTextHelpFormatter
+from datetime import date, datetime, time, timedelta
+
+# GVM Specific
+from gvm.protocols.gmp import Gmp
+from gvmtools.helper import error_and_exit
+
+HELP_TEXT = (
+    "This script generates a csv file with certificates "
+    "from Greenbone Vulnerability Manager.\n"
+    "Optional: Specify csv filename and days in the past to get data from as positional arguments\n"
+    "or live with the defaults\n"
+    "csv file will contain:\n"
+    "Subject, Issuer, Serial, SHA256 Fingerprint, MD5 Fingerprint, last_seen, Valid From, Valid To"
+)
+
+
+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",
+        nargs="?",
+        default="gvm_certificates.csv",
+        type=str,
+        help=(
+            "Optional: CSV File with certificate information - Default: gvm_certificates.csv"
+        ),
+    )
+
+    parser.add_argument(
+        "delta_days",
+        nargs="?",
+        default="1",
+        type=int,
+        help=(
+            "Optional: Number of days in the past to pull information - Default: 1 day"
+        ),
+    )
+
+    script_args, _ = parser.parse_known_args(args)
+    return script_args
+
+
+def list_tls_certificates(
+    gmp: Gmp, from_date: date, to_date: date, csvfilename: str
+) -> None:
+    tls_cert_filter = (
+        f"rows=-1 and modified>{from_date.isoformat()} "
+        f"and modified<{to_date.isoformat()}"
+    )
+
+    cert_info = []
+
+    tls_cert_xml = gmp.get_tls_certificates(filter_string=tls_cert_filter)
+    # pretty_print(tls_cert_xml)
+
+    for tls_cert in tls_cert_xml.xpath("tls_certificate"):
+
+        cert_seen = tls_cert.xpath("last_seen/text()")[0]
+
+        cert_from = tls_cert.xpath("activation_time/text()")[0]
+
+        cert_to = tls_cert.xpath("expiration_time/text()")[0]
+
+        cert_subject = tls_cert.xpath("subject_dn/text()")[0]
+
+        cert_issuer = tls_cert.xpath("issuer_dn/text()")[0]
+
+        cert_serial = tls_cert.xpath("serial/text()")[0]
+
+        cert_sha256 = tls_cert.xpath("sha256_fingerprint/text()")[0]
+
+        cert_md5 = tls_cert.xpath("md5_fingerprint/text()")[0]
+
+        cert_info.append(
+            [
+                cert_subject,
+                cert_issuer,
+                cert_serial,
+                cert_sha256,
+                cert_md5,
+                cert_seen,
+                cert_from,
+                cert_to,
+            ]
+        )
+
+    # Write the list host_info to csv file
+    writecsv(csvfilename, cert_info)
+    print(
+        f"CSV file: {csvfilename}\n"
+        f"From:     {from_date}\n"
+        f"To:       {to_date}\n"
+    )
+
+
+def writecsv(csv_filename: str, hostinfo: list) -> None:
+    field_names = [
+        "Subject",
+        "Issuer",
+        "Serial",
+        "SHA256 Fingerprint",
+        "MD5 Fingerprint",
+        "Last seen",
+        "Valid From",
+        "Valid To",
+    ]
+    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
+    args = args.script[1:]
+    parsed_args = parse_args(args=args)
+    csv_filename = parsed_args.csv_filename
+    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 certs
+    list_tls_certificates(gmp, from_date, to_date, csv_filename)
+
+
+if __name__ == "__gmp__":
+    main(gmp, args)

gvm_tools-25.3.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)