python-gvm 27.5.0__tar.gz → 27.6.0__tar.gz

{python_gvm-27.5.0 → python_gvm-27.6.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-gvm
-Version: 27.5.0
+Version: 27.6.0
 Summary: Library to communicate with remote servers over GMP or OSP
 Project-URL: Homepage, https://github.com/greenbone/python-gvm/
 Project-URL: Repository, https://github.com/greenbone/python-gvm/
@@ -25,7 +25,7 @@ Requires-Dist: lxml>=4.5.0
 Requires-Dist: paramiko>=2.7.1
 Description-Content-Type: text/markdown
 
-![Greenbone Logo](https://www.greenbone.net/wp-content/uploads/gb_new-logo_horizontal_rgb_small.png)
+![Greenbone Logo](https://www.greenbone.net/wp-content/uploads/greenbone-logo-2025.png)
 
 # Greenbone Vulnerability Management Python Library <!-- omit in toc -->
 

{python_gvm-27.5.0 → python_gvm-27.6.0}/README.md

@@ -1,4 +1,4 @@
-![Greenbone Logo](https://www.greenbone.net/wp-content/uploads/gb_new-logo_horizontal_rgb_small.png)
+![Greenbone Logo](https://www.greenbone.net/wp-content/uploads/greenbone-logo-2025.png)
 
 # Greenbone Vulnerability Management Python Library <!-- omit in toc -->
 

{python_gvm-27.5.0 → python_gvm-27.6.0}/gvm/__version__.py

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

{python_gvm-27.5.0 → python_gvm-27.6.0}/gvm/protocols/gmp/_gmpnext.py

@@ -16,6 +16,7 @@ from .requests.next import (
     AgentInstallerInstructions,
     Agents,
     AliveTest,
+    AuditReport,
     Credentials,
     CredentialStoreCredentialType,
     CredentialStores,
@@ -30,12 +31,14 @@ from .requests.next import (
     ReportPorts,
     ReportTlsCertificates,
     ReportVulnerabilities,
+    ScanReports,
     Targets,
     Tasks,
     WebApplicationTargets,
 )
 from .requests.v224 import AliveTest as AliveTestV224
 from .requests.v224 import HostsOrdering
+from .requests.v226 import ReportFormatType
 
 
 class GMPNext(GMPv227[T]):
@@ -1089,6 +1092,36 @@ class GMPNext(GMPv227[T]):
             )
         )
 
+    def get_audit_report_hosts(
+        self,
+        report_id: EntityID,
+        *,
+        filter_string: str | None = None,
+        filter_id: str | None = None,
+        ignore_pagination: bool | None = None,
+        details: bool | None = True,
+    ) -> T:
+        """Request hosts of a single audit report.
+
+        Args:
+            report_id: UUID of an existing report.
+            filter_string: Filter term to use to filter results in the report
+            filter_id: UUID of filter to use to filter results in the report
+            ignore_pagination: Whether to ignore the filter terms "first" and
+                "rows".
+            details: Request additional report host information details.
+                Defaults to True.
+        """
+        return self._send_request_and_transform_response(
+            ReportHosts.get_audit_report_hosts(
+                report_id=report_id,
+                filter_string=filter_string,
+                filter_id=filter_id,
+                ignore_pagination=ignore_pagination,
+                details=details,
+            )
+        )
+
     def get_report_operating_systems(
         self,
         report_id: EntityID,
@@ -1642,3 +1675,86 @@ class GMPNext(GMPv227[T]):
                 tasks=tasks,
             )
         )
+
+    def get_scan_report(
+        self,
+        scan_report_id: EntityID,
+        *,
+        filter_string: str | None = None,
+        filter_id: str | None = None,
+    ) -> T:
+        """ "Request a structured summary of a single scan report.
+
+        Args:
+            scan_report_id: UUID of an existing scan report.
+            filter_string: Filter term to apply to the report results.
+            filter_id: UUID of a saved filter to apply to the report results.
+
+        Returns:
+            A request for the get_scan_report GMP command.
+
+        Raises:
+            RequiredArgument: If scan_report_id is not provided.
+        """
+        return self._send_request_and_transform_response(
+            ScanReports.get_scan_report(
+                scan_report_id=scan_report_id,
+                filter_string=filter_string,
+                filter_id=filter_id,
+            )
+        )
+
+    def get_audit_report(  # type: ignore[override]
+        self,
+        audit_report_id: EntityID,
+        *,
+        filter_string: str | None = None,
+        filter_id: str | None = None,
+    ) -> T:
+        """Request a structured summary of a single audit report.
+
+        Args:
+            audit_report_id: UUID of an existing audit report.
+            filter_string: Filter term to apply to the report results.
+            filter_id: UUID of a saved filter to apply to the report results.
+
+        Returns:
+            A request for the get_audit_report GMP command.
+
+        Raises:
+            RequiredArgument: If audit_report_id is not provided.
+        """
+        return self._send_request_and_transform_response(
+            AuditReport.get_audit_report(
+                audit_report_id=audit_report_id,
+                filter_string=filter_string,
+                filter_id=filter_id,
+            )
+        )
+
+    def get_audit_report_legacy(
+        self,
+        report_id: EntityID,
+        *,
+        filter_string: str | None = None,
+        filter_id: str | None = None,
+        delta_report_id: EntityID | None = None,
+        report_format_id: str | ReportFormatType | None = None,
+        ignore_pagination: bool | None = None,
+        details: bool | None = True,
+    ) -> T:
+        """Request an audit report using the legacy command.
+
+        Deprecated:
+            Use ``get_audit_report`` instead. This method will be removed
+            in the next major release.
+        """
+        return super().get_audit_report(
+            report_id,
+            filter_string=filter_string,
+            filter_id=filter_id,
+            delta_report_id=delta_report_id,
+            report_format_id=report_format_id,
+            ignore_pagination=ignore_pagination,
+            details=details,
+        )

{python_gvm-27.5.0 → python_gvm-27.6.0}/gvm/protocols/gmp/requests/next/__init__.py

@@ -8,6 +8,7 @@ from gvm.protocols.gmp.requests.next._agent_installer_instructions import (
     AgentInstallerInstructions,
 )
 from gvm.protocols.gmp.requests.next._agents import Agents
+from gvm.protocols.gmp.requests.next._audit_report import AuditReport
 from gvm.protocols.gmp.requests.next._credential_stores import CredentialStores
 from gvm.protocols.gmp.requests.next._credentials import (
     Credentials,
@@ -44,6 +45,7 @@ from gvm.protocols.gmp.requests.next._report_tls_certificates import (
 from gvm.protocols.gmp.requests.next._report_vulnerabilities import (
     ReportVulnerabilities,
 )
+from gvm.protocols.gmp.requests.next._scan_report import ScanReports
 from gvm.protocols.gmp.requests.next._targets import AliveTest, Targets
 from gvm.protocols.gmp.requests.next._tasks import Tasks
 from gvm.protocols.gmp.requests.next._web_application_targets import (
@@ -130,6 +132,7 @@ __all__ = (
     "AlertMethod",
     "Alerts",
     "AliveTest",
+    "AuditReport",
     "AuditReports",
     "Audits",
     "Authentication",
@@ -184,6 +187,7 @@ __all__ = (
     "Results",
     "Roles",
     "ScanConfigs",
+    "ScanReports",
     "ScannerType",
     "Scanners",
     "Schedules",

python_gvm-27.6.0/gvm/protocols/gmp/requests/next/_audit_report.py

@@ -0,0 +1,39 @@
+from gvm.errors import RequiredArgument
+from gvm.protocols.core import Request
+from gvm.protocols.gmp.requests import EntityID
+from gvm.xml import XmlCommand
+
+
+class AuditReport:
+    @classmethod
+    def get_audit_report(
+        cls,
+        audit_report_id: EntityID,
+        *,
+        filter_string: str | None = None,
+        filter_id: str | None = None,
+    ) -> Request:
+        """Request a structured summary of a single audit report.
+
+        Args:
+            audit_report_id: UUID of an existing audit report.
+            filter_string: Filter term to apply to the report results.
+            filter_id: UUID of a saved filter to apply to the report results.
+
+        Returns:
+            A request for the get_audit_report GMP command.
+
+        Raises:
+            RequiredArgument: If audit_report_id is not provided.
+        """
+        if not audit_report_id:
+            raise RequiredArgument(
+                function=cls.get_audit_report.__name__,
+                argument="audit_report_id",
+            )
+
+        cmd = XmlCommand("get_audit_report")
+        cmd.set_attribute("audit_report_id", str(audit_report_id))
+        cmd.add_filter(filter_string, filter_id)
+
+        return cmd

{python_gvm-27.5.0 → python_gvm-27.6.0}/gvm/protocols/gmp/requests/next/_report_hosts.py

@@ -44,3 +44,42 @@ class ReportHosts:
         cmd.set_attribute("details", to_bool(details))
 
         return cmd
+
+    @classmethod
+    def get_audit_report_hosts(
+        cls,
+        report_id: EntityID,
+        *,
+        filter_string: str | None = None,
+        filter_id: str | None = None,
+        ignore_pagination: bool | None = None,
+        details: bool | None = True,
+    ) -> Request:
+        """Request hosts of a single audit report.
+
+        Args:
+            report_id: UUID of an existing report.
+            filter_string: Filter term to use to filter results in the report
+            filter_id: UUID of filter to use to filter results in the report
+            ignore_pagination: Whether to ignore the filter terms "first" and
+                "rows".
+            details: Request additional report host information details.
+                Defaults to True.
+        """
+        cmd = XmlCommand("get_audit_report_hosts")
+
+        if not report_id:
+            raise RequiredArgument(
+                function=cls.get_report_hosts.__name__, argument="report_id"
+            )
+
+        cmd.set_attribute("report_id", str(report_id))
+
+        cmd.add_filter(filter_string, filter_id)
+
+        if ignore_pagination is not None:
+            cmd.set_attribute("ignore_pagination", to_bool(ignore_pagination))
+
+        cmd.set_attribute("details", to_bool(details))
+
+        return cmd

python_gvm-27.6.0/gvm/protocols/gmp/requests/next/_scan_report.py

@@ -0,0 +1,39 @@
+from gvm.errors import RequiredArgument
+from gvm.protocols.core import Request
+from gvm.protocols.gmp.requests import EntityID
+from gvm.xml import XmlCommand
+
+
+class ScanReports:
+    @classmethod
+    def get_scan_report(
+        cls,
+        scan_report_id: EntityID,
+        *,
+        filter_string: str | None = None,
+        filter_id: str | None = None,
+    ) -> Request:
+        """Request a structured summary of a single scan report.
+
+        Args:
+            scan_report_id: UUID of an existing scan report.
+            filter_string: Filter term to apply to the report results.
+            filter_id: UUID of a saved filter to apply to the report results.
+
+        Returns:
+            A request for the get_scan_report GMP command.
+
+        Raises:
+            RequiredArgument: If scan_report_id is not provided.
+        """
+        if not scan_report_id:
+            raise RequiredArgument(
+                function=cls.get_scan_report.__name__,
+                argument="scan_report_id",
+            )
+
+        cmd = XmlCommand("get_scan_report")
+        cmd.set_attribute("scan_report_id", str(scan_report_id))
+        cmd.add_filter(filter_string, filter_id)
+
+        return cmd

{python_gvm-27.5.0 → python_gvm-27.6.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "python-gvm"
-version = "27.5.0"
+version = "27.6.0"
 description = "Library to communicate with remote servers over GMP or OSP"
 authors = [{ name = "Greenbone AG", email = "info@greenbone.net" }]
 requires-python = ">=3.10,<4"

python_gvm-27.6.0/tests/protocols/gmpnext/entities/audit_report/__init__.py

@@ -0,0 +1,16 @@
+#  SPDX-FileCopyrightText: 2026 Greenbone AG
+#
+#  SPDX-License-Identifier: GPL-3.0-or-later
+#
+
+from .test_get_audit_report import (
+    GmpGetAuditReportTestMixin,
+)
+from .test_get_audit_report_legacy import (
+    GmpGetAuditReportLegacyTestMixin,
+)
+
+__all__ = (
+    "GmpGetAuditReportLegacyTestMixin",
+    "GmpGetAuditReportTestMixin",
+)

python_gvm-27.6.0/tests/protocols/gmpnext/entities/audit_report/test_get_audit_report.py

@@ -0,0 +1,54 @@
+# SPDX-FileCopyrightText: 2026 Greenbone AG
+#
+# SPDX-License-Identifier: GPL-3.0-or-later
+#
+
+from gvm.errors import RequiredArgument
+
+
+class GmpGetAuditReportTestMixin:
+    def test_get_audit_report_without_id(self):
+        with self.assertRaises(RequiredArgument):
+            self.gmp.get_audit_report(None)
+
+        with self.assertRaises(RequiredArgument):
+            self.gmp.get_audit_report("")
+
+    def test_get_audit_report_with_id(self):
+        self.gmp.get_audit_report(audit_report_id="r1")
+
+        self.connection.send.has_been_called_with(
+            b'<get_audit_report audit_report_id="r1"/>'
+        )
+
+    def test_get_audit_report_with_filter_string(self):
+        self.gmp.get_audit_report(
+            audit_report_id="r1",
+            filter_string="name=foo",
+        )
+
+        self.connection.send.has_been_called_with(
+            b'<get_audit_report audit_report_id="r1" filter="name=foo"/>'
+        )
+
+    def test_get_audit_report_with_filter_id(self):
+        self.gmp.get_audit_report(
+            audit_report_id="r1",
+            filter_id="f1",
+        )
+
+        self.connection.send.has_been_called_with(
+            b'<get_audit_report audit_report_id="r1" filt_id="f1"/>'
+        )
+
+    def test_get_audit_report_with_filter_string_and_filter_id(self):
+        self.gmp.get_audit_report(
+            audit_report_id="r1",
+            filter_string="name=foo",
+            filter_id="f1",
+        )
+
+        self.connection.send.has_been_called_with(
+            b'<get_audit_report audit_report_id="r1" '
+            b'filter="name=foo" filt_id="f1"/>'
+        )

python_gvm-27.6.0/tests/protocols/gmpnext/entities/audit_report/test_get_audit_report_legacy.py

@@ -0,0 +1,85 @@
+# SPDX-FileCopyrightText: 2026 Greenbone AG
+#
+# SPDX-License-Identifier: GPL-3.0-or-later
+#
+
+from gvm.errors import RequiredArgument
+from gvm.protocols.gmp.requests.v226 import ReportFormatType
+
+
+class GmpGetAuditReportLegacyTestMixin:
+    def test_get_audit_report_legacy_without_id(self):
+        with self.assertRaises(RequiredArgument):
+            self.gmp.get_audit_report_legacy(None)
+
+        with self.assertRaises(RequiredArgument):
+            self.gmp.get_audit_report_legacy("")
+
+    def test_get_audit_report_legacy_with_filter_string(self):
+        self.gmp.get_audit_report_legacy(
+            report_id="r1", filter_string="name=foo"
+        )
+
+        self.connection.send.has_been_called_with(
+            b'<get_reports report_id="r1" usage_type="audit" filter="name=foo" details="1"/>'
+        )
+
+    def test_get_audit_report_legacy_with_filter_id(self):
+        self.gmp.get_audit_report_legacy(report_id="r1", filter_id="f1")
+
+        self.connection.send.has_been_called_with(
+            b'<get_reports report_id="r1" usage_type="audit" filt_id="f1" details="1"/>'
+        )
+
+    def test_get_audit_report_legacy_with_report_format_id(self):
+        self.gmp.get_audit_report_legacy(report_id="r1", report_format_id="bar")
+
+        self.connection.send.has_been_called_with(
+            b'<get_reports report_id="r1" usage_type="audit" format_id="bar" details="1"/>'
+        )
+
+    def test_get_audit_report_legacy_with_report_format_type(self):
+        self.gmp.get_audit_report_legacy(
+            report_id="r1", report_format_id=ReportFormatType.TXT
+        )
+        report_format_id = ReportFormatType.from_string("txt").value
+
+        self.connection.send.has_been_called_with(
+            '<get_reports report_id="r1" usage_type="audit" format_id='
+            f'"{report_format_id}" details="1"/>'.encode()
+        )
+
+    def test_get_audit_report_legacy_with_delta_report_id(self):
+        self.gmp.get_audit_report_legacy(report_id="r1", delta_report_id="r2")
+
+        self.connection.send.has_been_called_with(
+            b'<get_reports report_id="r1" usage_type="audit" delta_report_id="r2" details="1"/>'
+        )
+
+    def test_get_audit_report_legacy_with_ignore_pagination(self):
+        self.gmp.get_audit_report_legacy(report_id="r1", ignore_pagination=True)
+
+        self.connection.send.has_been_called_with(
+            b'<get_reports report_id="r1" usage_type="audit" ignore_pagination="1" details="1"/>'
+        )
+
+        self.gmp.get_audit_report_legacy(
+            report_id="r1", ignore_pagination=False
+        )
+
+        self.connection.send.has_been_called_with(
+            b'<get_reports report_id="r1" usage_type="audit" ignore_pagination="0" details="1"/>'
+        )
+
+    def test_get_audit_report_legacy_with_details(self):
+        self.gmp.get_audit_report_legacy(report_id="r1", details=True)
+
+        self.connection.send.has_been_called_with(
+            b'<get_reports report_id="r1" usage_type="audit" details="1"/>'
+        )
+
+        self.gmp.get_audit_report_legacy(report_id="r1", details=False)
+
+        self.connection.send.has_been_called_with(
+            b'<get_reports report_id="r1" usage_type="audit" details="0"/>'
+        )

python_gvm-27.6.0/tests/protocols/gmpnext/entities/report_hosts/test_get_audit_report_hosts.py

@@ -0,0 +1,57 @@
+# SPDX-FileCopyrightText: 2026 Greenbone AG
+#
+# SPDX-License-Identifier: GPL-3.0-or-later
+#
+
+from gvm.errors import RequiredArgument
+
+
+class GmpGetAuditReportHostsTestMixin:
+    def test_get_audit_report_hosts_without_id(self):
+        with self.assertRaises(RequiredArgument):
+            self.gmp.get_audit_report_hosts(None)
+
+        with self.assertRaises(RequiredArgument):
+            self.gmp.get_audit_report_hosts("")
+
+    def test_get_audit_report_hosts_with_filter_string(self):
+        self.gmp.get_audit_report_hosts(
+            report_id="r1", filter_string="name=foo"
+        )
+
+        self.connection.send.has_been_called_with(
+            b'<get_audit_report_hosts report_id="r1" filter="name=foo" details="1"/>'
+        )
+
+    def test_get_audit_report_hosts_with_filter_id(self):
+        self.gmp.get_audit_report_hosts(report_id="r1", filter_id="f1")
+
+        self.connection.send.has_been_called_with(
+            b'<get_audit_report_hosts report_id="r1" filt_id="f1" details="1"/>'
+        )
+
+    def test_get_audit_report_hosts_with_ignore_pagination(self):
+        self.gmp.get_audit_report_hosts(report_id="r1", ignore_pagination=True)
+
+        self.connection.send.has_been_called_with(
+            b'<get_audit_report_hosts report_id="r1" ignore_pagination="1" details="1"/>'
+        )
+
+        self.gmp.get_audit_report_hosts(report_id="r1", ignore_pagination=False)
+
+        self.connection.send.has_been_called_with(
+            b'<get_audit_report_hosts report_id="r1" ignore_pagination="0" details="1"/>'
+        )
+
+    def test_get_audit_report_hosts_with_details(self):
+        self.gmp.get_audit_report_hosts(report_id="r1", details=True)
+
+        self.connection.send.has_been_called_with(
+            b'<get_audit_report_hosts report_id="r1" details="1"/>'
+        )
+
+        self.gmp.get_audit_report_hosts(report_id="r1", details=False)
+
+        self.connection.send.has_been_called_with(
+            b'<get_audit_report_hosts report_id="r1" details="0"/>'
+        )

python_gvm-27.6.0/tests/protocols/gmpnext/entities/scan_reports/__init__.py

@@ -0,0 +1,10 @@
+#  SPDX-FileCopyrightText: 2026 Greenbone AG
+#
+#  SPDX-License-Identifier: GPL-3.0-or-later
+#
+
+from .test_get_scan_report import (
+    GmpGetScanReportTestMixin,
+)
+
+__all__ = ("GmpGetScanReportTestMixin",)

python_gvm-27.6.0/tests/protocols/gmpnext/entities/scan_reports/test_get_scan_report.py

@@ -0,0 +1,54 @@
+# SPDX-FileCopyrightText: 2026 Greenbone AG
+#
+# SPDX-License-Identifier: GPL-3.0-or-later
+#
+
+from gvm.errors import RequiredArgument
+
+
+class GmpGetScanReportTestMixin:
+    def test_get_scan_report_without_id(self):
+        with self.assertRaises(RequiredArgument):
+            self.gmp.get_scan_report(None)
+
+        with self.assertRaises(RequiredArgument):
+            self.gmp.get_scan_report("")
+
+    def test_get_scan_report_with_id(self):
+        self.gmp.get_scan_report(scan_report_id="r1")
+
+        self.connection.send.has_been_called_with(
+            b'<get_scan_report scan_report_id="r1"/>'
+        )
+
+    def test_get_scan_report_with_filter_string(self):
+        self.gmp.get_scan_report(
+            scan_report_id="r1",
+            filter_string="name=foo",
+        )
+
+        self.connection.send.has_been_called_with(
+            b'<get_scan_report scan_report_id="r1" filter="name=foo"/>'
+        )
+
+    def test_get_scan_report_with_filter_id(self):
+        self.gmp.get_scan_report(
+            scan_report_id="r1",
+            filter_id="f1",
+        )
+
+        self.connection.send.has_been_called_with(
+            b'<get_scan_report scan_report_id="r1" filt_id="f1"/>'
+        )
+
+    def test_get_scan_report_with_filter_string_and_filter_id(self):
+        self.gmp.get_scan_report(
+            scan_report_id="r1",
+            filter_string="name=foo",
+            filter_id="f1",
+        )
+
+        self.connection.send.has_been_called_with(
+            b'<get_scan_report scan_report_id="r1" '
+            b'filter="name=foo" filt_id="f1"/>'
+        )

python_gvm-27.6.0/tests/protocols/gmpnext/entities/test_audit_report.py

@@ -0,0 +1,20 @@
+# SPDX-FileCopyrightText: 2026 Greenbone AG
+#
+# SPDX-License-Identifier: GPL-3.0-or-later
+#
+
+from ...gmpnext import GMPTestCase
+from ...gmpnext.entities.audit_report import (
+    GmpGetAuditReportLegacyTestMixin,
+    GmpGetAuditReportTestMixin,
+)
+
+
+class GmpGetAuditReportTestCase(GmpGetAuditReportTestMixin, GMPTestCase):
+    pass
+
+
+class GmpGetAuditReportLegacyTestCase(
+    GmpGetAuditReportLegacyTestMixin, GMPTestCase
+):
+    pass

{python_gvm-27.5.0 → python_gvm-27.6.0}/tests/protocols/gmpnext/entities/test_report_hosts.py

@@ -4,6 +4,9 @@
 #
 
 from ...gmpnext import GMPTestCase
+from .report_hosts.test_get_audit_report_hosts import (
+    GmpGetAuditReportHostsTestMixin,
+)
 from .report_hosts.test_get_report_hosts import (
     GmpGetReportHostsTestMixin,
 )
@@ -11,3 +14,9 @@ from .report_hosts.test_get_report_hosts import (
 
 class GmpGetReportHostsTestCase(GmpGetReportHostsTestMixin, GMPTestCase):
     pass
+
+
+class GmpGetAuditReportHostsTestCase(
+    GmpGetAuditReportHostsTestMixin, GMPTestCase
+):
+    pass

python_gvm-27.6.0/tests/protocols/gmpnext/entities/test_scan_reports.py

@@ -0,0 +1,13 @@
+# SPDX-FileCopyrightText: 2026 Greenbone AG
+#
+# SPDX-License-Identifier: GPL-3.0-or-later
+#
+
+from ...gmpnext import GMPTestCase
+from .scan_reports.test_get_scan_report import (
+    GmpGetScanReportTestMixin,
+)
+
+
+class GmpGetScanReportTestCase(GmpGetScanReportTestMixin, GMPTestCase):
+    pass