PyPI - python-gvm - Versions diffs - 27.6.0__py3-none-any.whl → 27.7.0__py3-none-any.whl - Mend

python-gvm 27.6.0py3-none-any.whl → 27.7.0py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (9) hide show

gvm/__version__.py CHANGED Viewed

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

gvm/protocols/gmp/_gmpnext.py CHANGED Viewed

@@ -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,
+            )
+        )

gvm/protocols/gmp/requests/next/_scan_report.py CHANGED Viewed

@@ -1,6 +1,7 @@
 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
@@ -37,3 +38,76 @@ class ScanReports:
         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

gvm/protocols/http/openvasd/_client.py CHANGED Viewed

@@ -3,7 +3,10 @@
 # SPDX-License-Identifier: GPL-3.0-or-later
 """
-http client for initializing a connection to the openvasd HTTP API using optional mTLS authentication.
+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
@@ -22,11 +25,14 @@ def create_openvasd_http_client(
     client_cert_paths: StrOrPathLike
     | tuple[StrOrPathLike, StrOrPathLike]
     | None = None,
+    insecure_http: bool = False,
     port: int = 3000,
 ) -> Client:
     """
-    Create a `httpx.Client` configured for mTLS-secured or API KEY access
-    to an openvasd HTTP API instance.
+    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").
@@ -34,46 +40,54 @@ def create_openvasd_http_client(
         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 both `server_ca_path` and `client_cert_paths` are set, an mTLS connection
-            is established using an SSLContext.
-        - If not, `verify` is set to False (insecure), and HTTP is used instead of HTTPS.
-            HTTP connection needs api_key for authorization.
+        - 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
-    context: ssl.SSLContext | None = None
-    # Prepare mTLS SSL context if needed
-    if client_cert_paths and server_ca_path:
-        context = ssl.create_default_context(
-            ssl.Purpose.SERVER_AUTH, cafile=server_ca_path
+    if insecure_http:
+        return Client(
+            base_url=f"http://{host_name}:{port}",
+            headers=headers,
+            http2=True,
+            timeout=10.0,
         )
-        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
-    # Set verify based on context presence
-    verify: bool | ssl.SSLContext = context if context else False
-    if api_key:
-        headers["X-API-KEY"] = api_key
+    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)
-    protocol = "https" if context else "http"
-    base_url = f"{protocol}://{host_name}:{port}"
+    context.check_hostname = False
+    context.verify_mode = ssl.CERT_REQUIRED
     return Client(
-        base_url=base_url,
+        base_url=f"https://{host_name}:{port}",
         headers=headers,
-        verify=verify,
+        verify=context,
         http2=True,
         timeout=10.0,
     )

gvm/protocols/http/openvasd/_openvasd1.py CHANGED Viewed

@@ -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.dist-info → python_gvm-27.7.0.dist-info}/METADATA RENAMED Viewed

@@ -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.dist-info → python_gvm-27.7.0.dist-info}/RECORD RENAMED Viewed

@@ -1,5 +1,5 @@
 gvm/__init__.py,sha256=Eu3a8hRdlixDFn34Q-BwPXVN65KHpgFk_i0CYUdbfF8,412
-gvm/__version__.py,sha256=zkjBBcTOU9y-yAfS_zLUFOIEAx1x2CfkLUnZBfV1ByQ,103
+gvm/__version__.py,sha256=4TQ-2iqDj-a7CEfg_6neCIN7PJ6wsiqaJaZGgEq46OA,103
 gvm/_enum.py,sha256=n--ztwQQW2MU4M9E_4qJrw-32IGc4Laj6auZ8glMw_0,1168
 gvm/errors.py,sha256=FnZoe3ROKlAm8LMJ25uKRaG9cp-SG8hYIVtDMwwp0l0,5263
 gvm/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -27,7 +27,7 @@ gvm/protocols/gmp/_gmp224.py,sha256=NO-ufzkGW1RNzMHrIjlFm7r8QzSH0uRZK5xc9mWLRVI,
 gvm/protocols/gmp/_gmp225.py,sha256=3lz_AHTIQdBEr4DIYJ5o9D0Eke-Df3jUb0IZytITRdo,2227
 gvm/protocols/gmp/_gmp226.py,sha256=YqQ7CJIbUtM7s8wQPYX5BgePdhX-tUjCemanW0_DZtE,14543
 gvm/protocols/gmp/_gmp227.py,sha256=-q4Aci1I4FRtLle21qTwtkchE2ixWn1-Kug58X4dU5I,5713
-gvm/protocols/gmp/_gmpnext.py,sha256=0_-sE2uyu6ctUQPneyMPoaMZ5jPgZJxChbZVQN4dpTw,62532
+gvm/protocols/gmp/_gmpnext.py,sha256=-hZUiOZf0fd6DElCG97Bq0IkzmzThNl1EHRkWzDw_mE,64464
 gvm/protocols/gmp/requests/__init__.py,sha256=XH1zSifyz9Rx4FqY2lJ1mwurnUepHk7REZ-fSMC_Wx0,200
 gvm/protocols/gmp/requests/_entity_id.py,sha256=V96VhTg7_CF2AduaAHRYrGgTaOVA8_mG1lFiCl8-CMA,136
 gvm/protocols/gmp/requests/_version.py,sha256=GdHQnEVzJ6PbxoU4pxP36Oze1XvK5llWqB9bkC16Pf8,393
@@ -49,7 +49,7 @@ gvm/protocols/gmp/requests/next/_report_operating_systems.py,sha256=qN6-94OYKXGQ
 gvm/protocols/gmp/requests/next/_report_ports.py,sha256=xTzdBFKqYHv1ulH1BduWEE-wO3SzuMu0yU7pnB5jx5E,1477
 gvm/protocols/gmp/requests/next/_report_tls_certificates.py,sha256=-h1d3OVn873DLEHHvjeLVpOpvErJo5C3u5tyxIrXUI8,1559
 gvm/protocols/gmp/requests/next/_report_vulnerabilities.py,sha256=8TOQm-CyaHtTOL1dXDUrFYEzuohdeSs_TeonCeVJJzg,1543
-gvm/protocols/gmp/requests/next/_scan_report.py,sha256=V31NDmrHusVgGCN3OJ7rVUvb8T5l4PUTBd9VQoJDzSE,1196
+gvm/protocols/gmp/requests/next/_scan_report.py,sha256=uJTnoBxSGGRjFyI0v0AOTCDkgs0VEBoWwdoDdBO6Deo,3662
 gvm/protocols/gmp/requests/next/_targets.py,sha256=EIiYyPNrzflxjr3pmY0ZT25KSHn-ISERD3IfrzVauZI,12707
 gvm/protocols/gmp/requests/next/_tasks.py,sha256=4faG2a3wey9-fj-el4TiAwBUbu4H8M7EZ9WyO3SJ0QM,27016
 gvm/protocols/gmp/requests/next/_web_application_targets.py,sha256=03EYFVXKmVf0ZS_CTaXGsD-ALclSu9Hc2hm6p0LLV8o,6563
@@ -108,14 +108,14 @@ gvm/protocols/gmp/requests/v227/_scanners.py,sha256=-hxjO2gHZE2J2rNH51wJRAfVzbPY
 gvm/protocols/http/__init__.py,sha256=HnS3bXYZiYzU0E167TWDX5Egd9aCetsCrFTojVFIrd4,239
 gvm/protocols/http/openvasd/__init__.py,sha256=7AVS1dhfl5JsrnMyI9l7uVPSKEGsQq8dNAwfHGcucUk,392
 gvm/protocols/http/openvasd/_api.py,sha256=3p_DxXtWJNzN5yw2mxRCsDqaECVyftYO4mZAWaj3mNA,696
-gvm/protocols/http/openvasd/_client.py,sha256=oojeFLaq8gJI0q3cKpO1gHalie2eOa1bVt3cQSerC3U,2476
+gvm/protocols/http/openvasd/_client.py,sha256=ZMItdYHG0jmJUSsygqmfaK44W-bpGnFKQ33puuuSsRU,2924
 gvm/protocols/http/openvasd/_health.py,sha256=lHXyBs4i1He7jogvnn9y8-ElGmiHyU3SyCFUUC0Dlmc,2607
 gvm/protocols/http/openvasd/_metadata.py,sha256=W3TQeeNN-X-5vZ89WvsxwEym8EjQmOFPcBsya_bd3F8,3302
 gvm/protocols/http/openvasd/_notus.py,sha256=FwX5fFsx-FWXf4Rl_5seequkQ6XVS8jZ0NWb_5Lsk2s,1907
-gvm/protocols/http/openvasd/_openvasd1.py,sha256=YhV-OJULO4XJJQTsvAyH1ZVc5r1mRmGk2VMotvOoIxg,3896
+gvm/protocols/http/openvasd/_openvasd1.py,sha256=VS-fErATsT25SJxk0UVQRFETJ5OtGnrhk8aNsFqs7Ew,4074
 gvm/protocols/http/openvasd/_scans.py,sha256=U8aYmHudMQFtVzl9khjNsRRewY0sf8G376zTYZN6HQQ,16667
 gvm/protocols/http/openvasd/_vts.py,sha256=_T4j4SdXe0DthBA7pCehx4FXKYbQyhzpq72YNO4fKt4,2136
-python_gvm-27.6.0.dist-info/METADATA,sha256=s0Ez3Ltf4WZGKtH7SyYGaP9_cbXibtM9a_F2xLTWiXY,5696
-python_gvm-27.6.0.dist-info/WHEEL,sha256=lCkmxWfQsSc9CfIClYeavTdQeEX2toPqufh9gI35EQA,87
-python_gvm-27.6.0.dist-info/licenses/LICENSE,sha256=WJ7YI-moTFb-uVrFjnzzhGJrnL9P2iqQe8NuED3hutI,35141
-python_gvm-27.6.0.dist-info/RECORD,,
+python_gvm-27.7.0.dist-info/METADATA,sha256=4DiJ-kw4PfsYTZToseS8ZgpbN7JMep_F7HNQmxN4J6A,5699
+python_gvm-27.7.0.dist-info/WHEEL,sha256=zOwg4jB6zX2kU910N-cMawjivD6tO8NEWvE12je1bVk,87
+python_gvm-27.7.0.dist-info/licenses/LICENSE,sha256=WJ7YI-moTFb-uVrFjnzzhGJrnL9P2iqQe8NuED3hutI,35141
+python_gvm-27.7.0.dist-info/RECORD,,

{python_gvm-27.6.0.dist-info → python_gvm-27.7.0.dist-info}/WHEEL RENAMED Viewed

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: hatchling 1.31.0
+Generator: hatchling 1.32.0
 Root-Is-Purelib: true
 Tag: py3-none-any

{python_gvm-27.6.0.dist-info → python_gvm-27.7.0.dist-info}/licenses/LICENSE RENAMED Viewed

File without changes

python-gvm 27.6.0__py3-none-any.whl → 27.7.0__py3-none-any.whl

python-gvm 27.6.0py3-none-any.whl → 27.7.0py3-none-any.whl