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

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

@@ -1,6 +1,6 @@
-Metadata-Version: 2.4
+Metadata-Version: 2.5
 Name: python-gvm
-Version: 27.6.0
+Version: 27.7.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/
@@ -22,7 +22,7 @@ Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Requires-Python: <4,>=3.10
 Requires-Dist: httpx[http2]<0.29,>=0.28.1
 Requires-Dist: lxml>=4.5.0
-Requires-Dist: paramiko>=2.7.1
+Requires-Dist: paramiko<6,>=5.0.0
 Description-Content-Type: text/markdown
 
 ![Greenbone Logo](https://www.greenbone.net/wp-content/uploads/greenbone-logo-2025.png)

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

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

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

@@ -1758,3 +1758,53 @@ class GMPNext(GMPv227[T]):
             ignore_pagination=ignore_pagination,
             details=details,
         )
+
+    def export_scan_report(
+        self,
+        report_id: EntityID,
+        format_id: EntityID,
+        *,
+        config_id: EntityID | None = None,
+        filter_string: str | None = None,
+        ignore_pagination: bool = False,
+        lean: bool = False,
+        notes_details: bool = False,
+        overrides_details: bool = False,
+        result_tags: bool = False,
+    ) -> T:
+        """Request an asynchronous export of a scan report.
+
+        If an identical export is already pending or running, the existing
+        report export is returned instead of creating a duplicate.
+
+        Args:
+            report_id: UUID of the scan report to export.
+            format_id: UUID of the report format to apply.
+            config_id: UUID of an optional report configuration.
+            filter_string: Filter term to apply while generating the report.
+            ignore_pagination: Whether pagination settings in the filter
+                should be ignored.
+            lean: Whether lean report data should be generated.
+            notes_details: Whether note details should be included.
+            overrides_details: Whether override details should be included.
+            result_tags: Whether result tags should be included.
+
+        Returns:
+            A request for the export_scan_report GMP command.
+
+        Raises:
+            RequiredArgument: If report_id or format_id is not provided.
+        """
+        return self._send_request_and_transform_response(
+            ScanReports.export_scan_report(
+                report_id=report_id,
+                format_id=format_id,
+                config_id=config_id,
+                filter_string=filter_string,
+                ignore_pagination=ignore_pagination,
+                lean=lean,
+                notes_details=notes_details,
+                overrides_details=overrides_details,
+                result_tags=result_tags,
+            )
+        )

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

@@ -0,0 +1,113 @@
+from gvm.errors import RequiredArgument
+from gvm.protocols.core import Request
+from gvm.protocols.gmp.requests import EntityID
+from gvm.utils import to_bool
+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
+
+    @classmethod
+    def export_scan_report(
+        cls,
+        report_id: EntityID,
+        format_id: EntityID,
+        *,
+        config_id: EntityID | None = None,
+        filter_string: str | None = None,
+        ignore_pagination: bool = False,
+        lean: bool = False,
+        notes_details: bool = False,
+        overrides_details: bool = False,
+        result_tags: bool = False,
+    ) -> Request:
+        """Request an asynchronous export of a scan report.
+
+        If an identical export is already pending or running, the existing
+        report export is returned instead of creating a duplicate.
+
+        Args:
+            report_id: UUID of the scan report to export.
+            format_id: UUID of the report format to apply.
+            config_id: UUID of an optional report configuration.
+            filter_string: Filter term to apply while generating the report.
+            ignore_pagination: Whether pagination settings in the filter
+                should be ignored.
+            lean: Whether lean report data should be generated.
+            notes_details: Whether note details should be included.
+            overrides_details: Whether override details should be included.
+            result_tags: Whether result tags should be included.
+
+        Returns:
+            A request for the export_scan_report GMP command.
+
+        Raises:
+            RequiredArgument: If report_id is not provided.
+        """
+        if not report_id:
+            raise RequiredArgument(
+                function=cls.export_scan_report.__name__,
+                argument="report_id",
+            )
+
+        cmd = XmlCommand("export_scan_report")
+        cmd.set_attribute("report_id", str(report_id))
+        cmd.set_attribute("format_id", str(format_id))
+
+        if config_id:
+            cmd.set_attribute("config_id", str(config_id))
+
+        if filter_string is not None:
+            cmd.set_attribute("filter", filter_string)
+
+        cmd.set_attribute(
+            "ignore_pagination",
+            to_bool(ignore_pagination),
+        )
+        cmd.set_attribute("lean", to_bool(lean))
+        cmd.set_attribute(
+            "notes_details",
+            to_bool(notes_details),
+        )
+        cmd.set_attribute(
+            "overrides_details",
+            to_bool(overrides_details),
+        )
+        cmd.set_attribute(
+            "result_tags",
+            to_bool(result_tags),
+        )
+
+        return cmd

python_gvm-27.7.0/gvm/protocols/http/openvasd/_client.py

@@ -0,0 +1,93 @@
+# SPDX-FileCopyrightText: 2025 Greenbone AG
+#
+# SPDX-License-Identifier: GPL-3.0-or-later
+
+"""
+http client for initializing a connection to the openvasd HTTP API.
+
+HTTPS with mTLS is used by default. Plain HTTP can be enabled explicitly
+with `insecure_http=True`.
+"""
+
+import ssl
+from os import PathLike
+
+from httpx import Client
+
+StrOrPathLike = str | PathLike[str]
+
+
+def create_openvasd_http_client(
+    host_name: str,
+    *,
+    api_key: str | None = None,
+    server_ca_path: StrOrPathLike | None = None,
+    client_cert_paths: StrOrPathLike
+    | tuple[StrOrPathLike, StrOrPathLike]
+    | None = None,
+    insecure_http: bool = False,
+    port: int = 3000,
+) -> Client:
+    """
+    Create a `httpx.Client` configured for the OpenVASD HTTP API.
+
+    mTLS is used by default. Set `insecure_http=True` to use plain HTTP.
+    In this case, an API key can be used for authorization.
+
+    Args:
+        host_name: Hostname or IP of the OpenVASD server (e.g., "localhost").
+        api_key: Optional API key used for authentication via HTTP headers.
+        server_ca_path: Path to the server's CA certificate (for verifying the server).
+        client_cert_paths: Path to the client certificate (str) or a tuple of
+                            (cert_path, key_path) for mTLS authentication.
+        insecure_http: If True, disables SSL verification and uses HTTP instead of HTTPS.
+        port: The port to connect to (default: 3000).
+
+    Behavior:
+        - If `insecure_http=True`, HTTP is used instead of HTTPS.
+            An API key can be used for authorization.
+        - If `insecure_http=False` (default), HTTPS with mTLS is used.
+          Both `server_ca_path` and `client_cert_paths` are required.
+
+    Raises:
+        ValueError: If `insecure_http=False` and either
+            `server_ca_path` or `client_cert_paths` is missing.
+    """
+    headers = {}
+    if api_key:
+        headers["X-API-KEY"] = api_key
+
+    if insecure_http:
+        return Client(
+            base_url=f"http://{host_name}:{port}",
+            headers=headers,
+            http2=True,
+            timeout=10.0,
+        )
+
+    if not server_ca_path or not client_cert_paths:
+        raise ValueError(
+            "Both server_ca_path and client_cert_paths must be provided "
+            "when insecure_http is False."
+        )
+    # Prepare mTLS SSL context
+    context = ssl.create_default_context(
+        ssl.Purpose.SERVER_AUTH, cafile=server_ca_path
+    )
+    if isinstance(client_cert_paths, tuple):
+        context.load_cert_chain(
+            certfile=client_cert_paths[0], keyfile=client_cert_paths[1]
+        )
+    else:
+        context.load_cert_chain(certfile=client_cert_paths)
+
+    context.check_hostname = False
+    context.verify_mode = ssl.CERT_REQUIRED
+
+    return Client(
+        base_url=f"https://{host_name}:{port}",
+        headers=headers,
+        verify=context,
+        http2=True,
+        timeout=10.0,
+    )

{python_gvm-27.6.0 → python_gvm-27.7.0}/gvm/protocols/http/openvasd/_openvasd1.py

@@ -37,6 +37,7 @@ class OpenvasdHttpAPIv1:
         client_cert_paths: StrOrPathLike
         | tuple[StrOrPathLike, StrOrPathLike]
         | None = None,
+        insecure_http: bool = False,
         suppress_exceptions: bool = False,
     ):
         """
@@ -48,6 +49,7 @@ class OpenvasdHttpAPIv1:
             api_key: Optional API key to be used for authentication.
             server_ca_path: Path to the server CA certificate (for HTTPS/mTLS).
             client_cert_paths: Path to client certificate or (cert, key) tuple for mTLS.
+            insecure_http: If True, use HTTP instead of HTTPS and disable certificate verification.
             suppress_exceptions: If True, suppress exceptions and return structured error
                 responses. Default is False, which means exceptions will be raised.
         """
@@ -57,6 +59,7 @@ class OpenvasdHttpAPIv1:
             api_key=api_key,
             server_ca_path=server_ca_path,
             client_cert_paths=client_cert_paths,
+            insecure_http=insecure_http,
         )
 
         # Sub-API modules

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

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "python-gvm"
-version = "27.6.0"
+version = "27.7.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"
@@ -23,7 +23,7 @@ classifiers = [
     "Operating System :: OS Independent",
     "Topic :: Software Development :: Libraries :: Python Modules",
 ]
-dependencies = ["paramiko>=2.7.1", "lxml>=4.5.0", "httpx[http2]>=0.28.1,<0.29"]
+dependencies = ["paramiko>=5.0.0,<6", "lxml>=4.5.0", "httpx[http2]>=0.28.1,<0.29"]
 
 [project.urls]
 Homepage = "https://github.com/greenbone/python-gvm/"
@@ -39,7 +39,7 @@ dev = [
     "pontos>=26.4.0",
     "furo>=2022.6.21",
     "lxml-stubs>=0.5.1,<0.6",
-    "types-paramiko>=3.4.0.20240205,<5.0.0.0",
+    "types-paramiko>=5.0.0.20260617,<6.0.0.0",
     "git-cliff>=2.8.0,<3",
     "myst-parser>=4.0.0,<5 ; python_full_version >= '3.10' and python_full_version < '4'",
 ]

{python_gvm-27.6.0 → python_gvm-27.7.0}/tests/protocols/gmpnext/entities/scan_reports/__init__.py

@@ -3,8 +3,14 @@
 #  SPDX-License-Identifier: GPL-3.0-or-later
 #
 
+from .test_export_scan_report import (
+    GmpExportScanReportTestMixin,
+)
 from .test_get_scan_report import (
     GmpGetScanReportTestMixin,
 )
 
-__all__ = ("GmpGetScanReportTestMixin",)
+__all__ = (
+    "GmpExportScanReportTestMixin",
+    "GmpGetScanReportTestMixin",
+)

python_gvm-27.7.0/tests/protocols/gmpnext/entities/scan_reports/test_export_scan_report.py

@@ -0,0 +1,138 @@
+# SPDX-FileCopyrightText: 2026 Greenbone AG
+#
+# SPDX-License-Identifier: GPL-3.0-or-later
+#
+
+from gvm.errors import RequiredArgument
+
+
+class GmpExportScanReportTestMixin:
+    def test_export_scan_report_without_report_id(self):
+        with self.assertRaises(RequiredArgument):
+            self.gmp.export_scan_report(None, format_id="f1")
+
+        with self.assertRaises(RequiredArgument):
+            self.gmp.export_scan_report("", format_id="f1")
+
+    def test_export_scan_report(self):
+        self.gmp.export_scan_report(
+            report_id="r1",
+            format_id="f1",
+        )
+
+        self.connection.send.has_been_called_with(
+            b'<export_scan_report report_id="r1" format_id="f1" '
+            b'ignore_pagination="0" lean="0" notes_details="0" '
+            b'overrides_details="0" result_tags="0"/>'
+        )
+
+    def test_export_scan_report_with_config_id(self):
+        self.gmp.export_scan_report(
+            report_id="r1",
+            format_id="f1",
+            config_id="c1",
+        )
+
+        self.connection.send.has_been_called_with(
+            b'<export_scan_report report_id="r1" format_id="f1" '
+            b'config_id="c1" ignore_pagination="0" lean="0" '
+            b'notes_details="0" overrides_details="0" result_tags="0"/>'
+        )
+
+    def test_export_scan_report_with_filter_string(self):
+        self.gmp.export_scan_report(
+            report_id="r1",
+            format_id="f1",
+            filter_string="levels=hml",
+        )
+
+        self.connection.send.has_been_called_with(
+            b'<export_scan_report report_id="r1" format_id="f1" '
+            b'filter="levels=hml" ignore_pagination="0" lean="0" '
+            b'notes_details="0" overrides_details="0" result_tags="0"/>'
+        )
+
+    def test_export_scan_report_with_ignore_pagination(self):
+        self.gmp.export_scan_report(
+            report_id="r1",
+            format_id="f1",
+            ignore_pagination=True,
+        )
+
+        self.connection.send.has_been_called_with(
+            b'<export_scan_report report_id="r1" format_id="f1" '
+            b'ignore_pagination="1" lean="0" notes_details="0" '
+            b'overrides_details="0" result_tags="0"/>'
+        )
+
+    def test_export_scan_report_with_lean(self):
+        self.gmp.export_scan_report(
+            report_id="r1",
+            format_id="f1",
+            lean=True,
+        )
+
+        self.connection.send.has_been_called_with(
+            b'<export_scan_report report_id="r1" format_id="f1" '
+            b'ignore_pagination="0" lean="1" notes_details="0" '
+            b'overrides_details="0" result_tags="0"/>'
+        )
+
+    def test_export_scan_report_with_notes_details(self):
+        self.gmp.export_scan_report(
+            report_id="r1",
+            format_id="f1",
+            notes_details=True,
+        )
+
+        self.connection.send.has_been_called_with(
+            b'<export_scan_report report_id="r1" format_id="f1" '
+            b'ignore_pagination="0" lean="0" notes_details="1" '
+            b'overrides_details="0" result_tags="0"/>'
+        )
+
+    def test_export_scan_report_with_overrides_details(self):
+        self.gmp.export_scan_report(
+            report_id="r1",
+            format_id="f1",
+            overrides_details=True,
+        )
+
+        self.connection.send.has_been_called_with(
+            b'<export_scan_report report_id="r1" format_id="f1" '
+            b'ignore_pagination="0" lean="0" notes_details="0" '
+            b'overrides_details="1" result_tags="0"/>'
+        )
+
+    def test_export_scan_report_with_result_tags(self):
+        self.gmp.export_scan_report(
+            report_id="r1",
+            format_id="f1",
+            result_tags=True,
+        )
+
+        self.connection.send.has_been_called_with(
+            b'<export_scan_report report_id="r1" format_id="f1" '
+            b'ignore_pagination="0" lean="0" notes_details="0" '
+            b'overrides_details="0" result_tags="1"/>'
+        )
+
+    def test_export_scan_report_with_all_arguments(self):
+        self.gmp.export_scan_report(
+            report_id="r1",
+            format_id="f1",
+            config_id="c1",
+            filter_string="levels=hml",
+            ignore_pagination=True,
+            lean=True,
+            notes_details=True,
+            overrides_details=True,
+            result_tags=True,
+        )
+
+        self.connection.send.has_been_called_with(
+            b'<export_scan_report report_id="r1" format_id="f1" '
+            b'config_id="c1" filter="levels=hml" '
+            b'ignore_pagination="1" lean="1" notes_details="1" '
+            b'overrides_details="1" result_tags="1"/>'
+        )

{python_gvm-27.6.0 → python_gvm-27.7.0}/tests/protocols/gmpnext/entities/test_scan_reports.py

@@ -4,10 +4,15 @@
 #
 
 from ...gmpnext import GMPTestCase
-from .scan_reports.test_get_scan_report import (
+from .scan_reports import (
+    GmpExportScanReportTestMixin,
     GmpGetScanReportTestMixin,
 )
 
 
 class GmpGetScanReportTestCase(GmpGetScanReportTestMixin, GMPTestCase):
     pass
+
+
+class GmpExportScanReportTestCase(GmpExportScanReportTestMixin, GMPTestCase):
+    pass

{python_gvm-27.6.0 → python_gvm-27.7.0}/tests/protocols/http/openvasd/test_client.py

@@ -11,21 +11,29 @@ from gvm.protocols.http.openvasd._client import create_openvasd_http_client
 
 class TestOpenvasdClient(unittest.TestCase):
     @patch("gvm.protocols.http.openvasd._client.Client")
-    def test_init_without_tls_or_api_key(self, mock_httpx_client):
-        create_openvasd_http_client("localhost")
+    @patch("gvm.protocols.http.openvasd._client.ssl.create_default_context")
+    def test_init_without_tls_or_api_key(
+        self, mock_ssl_ctx_factory, mock_httpx_client
+    ):
+        create_openvasd_http_client("localhost", insecure_http=True)
         mock_httpx_client.assert_called_once()
         _, kwargs = mock_httpx_client.call_args
         self.assertEqual(kwargs["base_url"], "http://localhost:3000")
-        self.assertFalse(kwargs["verify"])
         self.assertNotIn("X-API-KEY", kwargs["headers"])
+        mock_ssl_ctx_factory.assert_not_called()
 
     @patch("gvm.protocols.http.openvasd._client.Client")
-    def test_init_with_api_key_only(self, mock_httpx_client):
-        create_openvasd_http_client("localhost", api_key="secret")
+    @patch("gvm.protocols.http.openvasd._client.ssl.create_default_context")
+    def test_init_with_api_key_and_insecure_http(
+        self, mock_ssl_ctx_factory, mock_httpx_client
+    ):
+        create_openvasd_http_client(
+            "localhost", api_key="secret", insecure_http=True
+        )
         _, kwargs = mock_httpx_client.call_args
         self.assertEqual(kwargs["headers"]["X-API-KEY"], "secret")
         self.assertEqual(kwargs["base_url"], "http://localhost:3000")
-        self.assertFalse(kwargs["verify"])
+        mock_ssl_ctx_factory.assert_not_called()
 
     @patch("gvm.protocols.http.openvasd._client.ssl.create_default_context")
     @patch("gvm.protocols.http.openvasd._client.Client")
@@ -72,3 +80,31 @@ class TestOpenvasdClient(unittest.TestCase):
         _, kwargs = mock_httpx_client.call_args
         self.assertEqual(kwargs["base_url"], "https://localhost:3000")
         self.assertEqual(kwargs["verify"], mock_context)
+
+    @patch("gvm.protocols.http.openvasd._client.ssl.create_default_context")
+    @patch("gvm.protocols.http.openvasd._client.Client")
+    def test_init_with_mtls_missing_cert(
+        self, mock_httpx_client, mock_ssl_ctx_factory
+    ):
+        with self.assertRaises(ValueError):
+            create_openvasd_http_client(
+                "localhost",
+                server_ca_path="/path/ca.pem",
+                client_cert_paths=None,
+            )
+        mock_httpx_client.assert_not_called()
+        mock_ssl_ctx_factory.assert_not_called()
+
+    @patch("gvm.protocols.http.openvasd._client.ssl.create_default_context")
+    @patch("gvm.protocols.http.openvasd._client.Client")
+    def test_init_with_mtls_missing_ca(
+        self, mock_httpx_client, mock_ssl_ctx_factory
+    ):
+        with self.assertRaises(ValueError):
+            create_openvasd_http_client(
+                "localhost",
+                server_ca_path=None,
+                client_cert_paths="/path/client.pem",
+            )
+        mock_httpx_client.assert_not_called()
+        mock_ssl_ctx_factory.assert_not_called()

{python_gvm-27.6.0 → python_gvm-27.7.0}/tests/protocols/http/openvasd/test_openvasd1.py

@@ -28,6 +28,39 @@ class TestOpenvasdHttpApiV1(unittest.TestCase):
             api_key="test-key",
             server_ca_path="/path/to/ca.pem",
             client_cert_paths=("/path/to/client.pem", "/path/to/key.pem"),
+            insecure_http=False,
+        )
+
+        self.assertEqual(api._client, mock_httpx_client)
+        self.assertEqual(api.health._client, mock_httpx_client)
+        self.assertEqual(api.metadata._client, mock_httpx_client)
+        self.assertEqual(api.notus._client, mock_httpx_client)
+        self.assertEqual(api.scans._client, mock_httpx_client)
+        self.assertEqual(api.vts._client, mock_httpx_client)
+
+    @patch("gvm.protocols.http.openvasd._openvasd1.create_openvasd_http_client")
+    def test_initializes_all_sub_apis_insecure_http(
+        self, mock_crate_openvasd_client
+    ):
+        mock_httpx_client = MagicMock()
+        mock_crate_openvasd_client.return_value = mock_httpx_client
+
+        api = OpenvasdHttpAPIv1(
+            host_name="localhost",
+            port=3000,
+            api_key="test-key",
+            server_ca_path="/path/to/ca.pem",
+            client_cert_paths=("/path/to/client.pem", "/path/to/key.pem"),
+            insecure_http=True,
+        )
+
+        mock_crate_openvasd_client.assert_called_once_with(
+            host_name="localhost",
+            port=3000,
+            api_key="test-key",
+            server_ca_path="/path/to/ca.pem",
+            client_cert_paths=("/path/to/client.pem", "/path/to/key.pem"),
+            insecure_http=True,
         )
 
         self.assertEqual(api._client, mock_httpx_client)