python-gvm 26.1.1__tar.gz → 26.2.0__tar.gz

{python_gvm-26.1.1 → python_gvm-26.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: python-gvm
-Version: 26.1.1
+Version: 26.2.0
 Summary: Library to communicate with remote servers over GMP or OSP
 License: GPL-3.0-or-later
 Author: Greenbone AG

{python_gvm-26.1.1 → python_gvm-26.2.0}/gvm/__init__.py

@@ -5,17 +5,15 @@
 """
 Main module of python-gvm.
 """
+
 from .__version__ import __version__
 
 
 def get_version() -> str:
-    """Returns the version of python-gvm as a string in `PEP440`_ compliant
-    format.
+    """Returns the version of python-gvm as a string in
+    `PEP440 <https://www.python.org/dev/peps/pep-0440>`_ compliant format.
 
     Returns:
         Current version of python-gvm
-
-    .. _PEP440:
-       https://www.python.org/dev/peps/pep-0440
     """
     return __version__

{python_gvm-26.1.1 → python_gvm-26.2.0}/gvm/__version__.py

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

{python_gvm-26.1.1 → python_gvm-26.2.0}/gvm/connections/_debug.py

@@ -13,9 +13,9 @@ class DebugConnection:
     """Wrapper around a connection for debugging purposes
 
     Allows to debug the connection flow including send and read data. Internally
-    it uses the python `logging`_ framework to create debug messages. Please
-    take a look at `the logging tutorial
-    <https://docs.python.org/3/howto/logging.html#logging-basic-tutorial>`_
+    it uses the python `logging <https://docs.python.org/3/library/logging.html>`_
+    framework to create debug messages. Please take a look at
+    `the logging tutorial <https://docs.python.org/3/howto/logging.html#logging-basic-tutorial>`_
     for further details.
 
     Example:
@@ -29,9 +29,6 @@ class DebugConnection:
         socket_connection = UnixSocketConnection(path='/var/run/gvm.sock')
         connection = DebugConnection(socket_connection)
         gmp = Gmp(connection=connection)
-
-    .. _logging:
-        https://docs.python.org/3/library/logging.html
     """
 
     def __init__(self, connection: GvmConnection):

{python_gvm-26.1.1 → python_gvm-26.2.0}/gvm/connections/_tls.py

@@ -41,17 +41,14 @@ class TLSConnection(AbstractGvmConnection):
             hostname: DNS name or IP address of the remote TLS server.
             port: Port for the TLS connection. Default is 9390.
             certfile: Path to PEM encoded certificate file. See
-                `python certificates`_ for details.
-            cafile: Path to PEM encoded CA file. See `python certificates`_
+                `python certificates <https://docs.python.org/3/library/ssl.html#certificates>`_ for details.
+            cafile: Path to PEM encoded CA file. See `python certificates <https://docs.python.org/3/library/ssl.html#certificates>`_
                 for details.
-            keyfile: Path to PEM encoded private key. See `python certificates`_
+            keyfile: Path to PEM encoded private key. See `python certificates <https://docs.python.org/3/library/ssl.html#certificates>`_
                 for details.
             password: Password for the private key. If the password argument is not
                 specified and a password is required it will be interactively prompt
                 the user for a password.
-
-        .. _python certificates:
-            https://docs.python.org/3/library/ssl.html#certificates
         """
         super().__init__(timeout=timeout)
 

python_gvm-26.2.0/gvm/protocols/__init__.py

@@ -0,0 +1,20 @@
+# SPDX-FileCopyrightText: 2018-2024 Greenbone AG
+#
+# SPDX-License-Identifier: GPL-3.0-or-later
+#
+"""
+Package for supported Greenbone Protocol versions.
+
+Currently GMP version 22.4, `GMP version 22.5`_,
+`GMP version 22.6`_, `GMP version 22.7`_
+and `OSP version 1`_ are supported.
+
+.. _GMP version 22.5:
+    https://docs.greenbone.net/API/GMP/gmp-22.5.html
+.. _GMP version 22.6:
+    https://docs.greenbone.net/API/GMP/gmp-22.6.html
+.. _GMP version 22.7:
+    https://docs.greenbone.net/API/GMP/gmp-22.7.html
+.. _OSP version 1:
+    https://docs.greenbone.net/API/OSP/osp-1.2.html
+"""

{python_gvm-26.1.1 → python_gvm-26.2.0}/gvm/protocols/_protocol.py

@@ -86,10 +86,7 @@ class GvmProtocol(Generic[T]):
 
         Normally connect is not called directly. Either it is called
         automatically when sending a protocol command or when using a
-        `with statement`_.
-
-        .. _with statement:
-            https://docs.python.org/3/reference/datamodel.html#with-statement-context-managers
+        `with statement <https://docs.python.org/3/reference/datamodel.html#with-statement-context-managers>`_.
         """
         if not self.is_connected():
             self._connection.connect()

{python_gvm-26.1.1 → python_gvm-26.2.0}/gvm/protocols/gmp/__init__.py

@@ -8,18 +8,21 @@ Protocol implementations for the Greenbone Management Protocol (GMP).
 In most circumstances you will want to use the :class:`GMP` class which
 dynamically selects the supported GMP protocol of the remote manager daemon.
 
-If you need to use a specific GMP version, you can use the :class:`GMPv224` or
-:class:`GMPv225` classes.
+If you need to use a specific GMP version, you can use the :class:`GMPv224`,
+:class:`GMPv225`, :class:`GMPv226` or :class:`GMPv227` classes.
 
 * :class:`GMP` - Dynamically select supported GMP protocol of the remote manager daemon.
 * :class:`GMPv224` - GMP version 22.4
 * :class:`GMPv225` - GMP version 22.5
+* :class:`GMPv226` - GMP version 22.6
+* :class:`GMPv227` - GMP version 22.7
 """
 
 from ._gmp import GMP
 from ._gmp224 import GMPv224
 from ._gmp225 import GMPv225
 from ._gmp226 import GMPv226
+from ._gmp227 import GMPv227
 
 Gmp = GMP  # for backwards compatibility
 
@@ -29,4 +32,5 @@ __all__ = (
     "GMPv224",
     "GMPv225",
     "GMPv226",
+    "GMPv227",
 )

{python_gvm-26.1.1 → python_gvm-26.2.0}/gvm/protocols/gmp/_gmp.py

@@ -15,17 +15,17 @@ from .._protocol import GvmProtocol, T, str_transform
 from ._gmp224 import GMPv224
 from ._gmp225 import GMPv225
 from ._gmp226 import GMPv226
+from ._gmp227 import GMPv227
 from .requests import Version
 
-SUPPORTED_GMP_VERSIONS = Union[GMPv224[T], GMPv225[T], GMPv226[T]]
-_SUPPORTED_GMP_VERSION_STRINGS = ["22.4", "22.5", "22.6"]
+SUPPORTED_GMP_VERSIONS = Union[GMPv224[T], GMPv225[T], GMPv226[T], GMPv227[T]]
+_SUPPORTED_GMP_VERSION_STRINGS = ["22.4", "22.5", "22.6", "22.7"]
 
 
 class GMP(GvmProtocol[T]):
     """Dynamically select supported GMP protocol of the remote manager daemon.
 
-    Must be used as a `Context Manager
-    <https://docs.python.org/3/reference/datamodel.html#context-managers>`_
+    Must be used as a `Context Manager <https://docs.python.org/3/reference/datamodel.html#context-managers>`_
 
     Example:
 
@@ -36,11 +36,11 @@ class GMP(GvmProtocol[T]):
             with GMP(connection) as gmp:
                 # gmp can be an instance of
                 # gvm.protocols.gmp.GMPv224,
-                # gvm.protocols.gmp.GMPv225
-                # or gvm.protocols.gmp.GMPv226
+                # gvm.protocols.gmp.GMPv225,
+                # gvm.protocols.gmp.GMPv226,
+                # or gvm.protocols.gmp.GMPv227
                 # depending on the supported GMP version of the remote manager daemon
                 resp = gmp.get_tasks()
-
     """
 
     def __init__(
@@ -55,15 +55,12 @@ class GMP(GvmProtocol[T]):
         Args:
             connection: Connection to use to talk with the remote daemon. See
                 :mod:`gvm.connections` for possible connection types.
-            transform: Optional transform `callable`_ to convert response data.
-                After each request the callable gets passed the plain response data
+            transform: Optional transform `callable <https://docs.python.org/3/library/functions.html#callable>`_
+                to convert response data. After each request the callable gets passed the plain response data
                 which can be used to check the data and/or conversion into different
                 representations like a xml dom.
 
                 See :mod:`gvm.transforms` for existing transforms.
-
-        .. _callable:
-            https://docs.python.org/3/library/functions.html#callable
         """
         super().__init__(connection, transform=transform)
         self._gmp: Optional[SUPPORTED_GMP_VERSIONS] = None
@@ -98,7 +95,7 @@ class GMP(GvmProtocol[T]):
             gmp_class = GMPv226
             if minor_version > 6:
                 warnings.warn(
-                    "Remote manager daemon uses a newer GMP version then "
+                    "Remote manager daemon uses a newer GMP version than "
                     f"supported by python-gvm {__version__}. Please update to "
                     "a newer release of python-gvm if possible. "
                     f"Remote GMP version is {major_version}.{minor_version}. "

{python_gvm-26.1.1 → python_gvm-26.2.0}/gvm/protocols/gmp/_gmp224.py

@@ -122,20 +122,18 @@ class GMPv224(GvmProtocol[T]):
 
     def __init__(self, *args, **kwargs):
         """
-        Create a new GMPv224 instance.
+        Create a new GMP protocol instance.
 
         Args:
             connection: Connection to use to talk with the remote daemon. See
                 :mod:`gvm.connections` for possible connection types.
-            transform: Optional transform `callable`_ to convert response data.
+            transform: Optional transform `callable <https://docs.python.org/3/library/functions.html#callable>`_
+                to convert response data.
                 After each request the callable gets passed the plain response data
                 which can be used to check the data and/or conversion into different
                 representations like a xml dom.
 
                 See :mod:`gvm.transforms` for existing transforms.
-
-        .. _callable:
-            https://docs.python.org/3/library/functions.html#callable
         """
         super().__init__(*args, **kwargs)
         self.types = to_dotted_types_dict(_TYPE_FIELDS)
@@ -3141,7 +3139,7 @@ class GMPv224(GvmProtocol[T]):
         *,
         comment: Optional[str] = None,
     ) -> T:
-        """Create a new schedule based in `iCalendar`_ data.
+        """Create a new schedule based in `iCalendar <https://tools.ietf.org/html/rfc5545>`_ data.
 
         Example:
             Requires https://pypi.org/project/icalendar/
@@ -3173,16 +3171,13 @@ class GMPv224(GvmProtocol[T]):
 
         Args:
             name: Name of the new schedule
-            icalendar: `iCalendar`_ (RFC 5545) based data.
+            icalendar: `iCalendar <https://tools.ietf.org/html/rfc5545>`_ (RFC 5545) based data.
             timezone: Timezone to use for the icalendar events e.g
                 Europe/Berlin. If the datetime values in the icalendar data are
                 missing timezone information this timezone gets applied.
                 Otherwise the datetime values from the icalendar data are
                 displayed in this timezone
             comment: Comment on schedule.
-
-        .. _iCalendar:
-            https://tools.ietf.org/html/rfc5545
         """
         return self._send_request_and_transform_response(
             Schedules.create_schedule(
@@ -3255,16 +3250,14 @@ class GMPv224(GvmProtocol[T]):
         Args:
             schedule_id: UUID of the schedule to be modified
             name: Name of the schedule
-            icalendar: `iCalendar`_ (RFC 5545) based data.
+            icalendar: `iCalendar <https://tools.ietf.org/html/rfc5545>`_
+                (RFC 5545) based data.
             timezone: Timezone to use for the icalendar events e.g
                 Europe/Berlin. If the datetime values in the icalendar data are
                 missing timezone information this timezone gets applied.
                 Otherwise the datetime values from the icalendar data are
                 displayed in this timezone
             comment: Comment on schedule.
-
-        .. _iCalendar:
-            https://tools.ietf.org/html/rfc5545
         """
         return self._send_request_and_transform_response(
             Schedules.modify_schedule(

{python_gvm-26.1.1 → python_gvm-26.2.0}/gvm/protocols/gmp/_gmp225.py

@@ -30,25 +30,6 @@ class GMPv225(GMPv224[T]):
                 resp = gmp.get_tasks()
     """
 
-    def __init__(self, *args, **kwargs):
-        """
-        Create a new GMPv225 instance.
-
-        Args:
-            connection: Connection to use to talk with the remote daemon. See
-                :mod:`gvm.connections` for possible connection types.
-            transform: Optional transform `callable`_ to convert response data.
-                After each request the callable gets passed the plain response data
-                which can be used to check the data and/or conversion into different
-                representations like a xml dom.
-
-                See :mod:`gvm.transforms` for existing transforms.
-
-        .. _callable:
-            https://docs.python.org/3/library/functions.html#callable
-        """
-        super().__init__(*args, **kwargs)
-
     @staticmethod
     def get_protocol_version() -> tuple[int, int]:
         return (22, 5)

{python_gvm-26.1.1 → python_gvm-26.2.0}/gvm/protocols/gmp/_gmp226.py

@@ -38,25 +38,6 @@ class GMPv226(GMPv225[T]):
                 resp = gmp.get_tasks()
     """
 
-    def __init__(self, *args, **kwargs):
-        """
-        Create a new GMPv226 instance.
-
-        Args:
-            connection: Connection to use to talk with the remote daemon. See
-                :mod:`gvm.connections` for possible connection types.
-            transform: Optional transform `callable`_ to convert response data.
-                After each request the callable gets passed the plain response data
-                which can be used to check the data and/or conversion into different
-                representations like a xml dom.
-
-                See :mod:`gvm.transforms` for existing transforms.
-
-        .. _callable:
-            https://docs.python.org/3/library/functions.html#callable
-        """
-        super().__init__(*args, **kwargs)
-
     @staticmethod
     def get_protocol_version() -> tuple[int, int]:
         return (22, 6)
@@ -122,6 +103,7 @@ class GMPv226(GMPv225[T]):
         filter_id: Optional[str] = None,
         delta_report_id: Optional[EntityID] = None,
         report_format_id: Optional[Union[str, ReportFormatType]] = None,
+        report_config_id: Optional[str] = None,
         ignore_pagination: Optional[bool] = None,
         details: Optional[bool] = True,
     ) -> T:
@@ -134,6 +116,7 @@ class GMPv226(GMPv225[T]):
             delta_report_id: UUID of an existing report to compare report to.
             report_format_id: UUID of report format to use
                               or ReportFormatType (enum)
+            report_config_id: UUID of report format config to use
             ignore_pagination: Whether to ignore the filter terms "first" and
                 "rows".
             details: Request additional report information details
@@ -146,6 +129,7 @@ class GMPv226(GMPv225[T]):
                 filter_id=filter_id,
                 delta_report_id=delta_report_id,
                 report_format_id=report_format_id,
+                report_config_id=report_config_id,
                 ignore_pagination=ignore_pagination,
                 details=details,
             )

python_gvm-26.2.0/gvm/protocols/gmp/_gmp227.py

@@ -0,0 +1,190 @@
+#  SPDX-FileCopyrightText: 2025 Greenbone AG
+#
+#  SPDX-License-Identifier: GPL-3.0-or-later
+
+"""
+Greenbone Management Protocol (GMP) version 22.7
+"""
+
+from typing import Optional, Union
+
+from .._protocol import T
+from ._gmp226 import GMPv226
+from .requests.v227 import (
+    EntityID,
+    Scanners,
+    ScannerType,
+)
+
+
+class GMPv227(GMPv226[T]):
+    """
+    A class implementing the Greenbone Management Protocol (GMP) version 22.7
+
+    Example:
+
+        .. code-block:: python
+
+            from gvm.protocols.gmp import GMPv227 as GMP
+
+            with GMP(connection) as gmp:
+                resp = gmp.get_tasks()
+    """
+
+    @staticmethod
+    def get_protocol_version() -> tuple[int, int]:
+        return (22, 7)
+
+    def create_scanner(  # type:ignore[override]
+        self,
+        name: str,
+        host: str,
+        port: Union[str, int],
+        scanner_type: ScannerType,
+        credential_id: str,
+        *,
+        ca_pub: Optional[str] = None,
+        comment: Optional[str] = None,
+        relay_host: Optional[str] = None,
+        relay_port: Optional[Union[str, int]] = None,
+    ) -> T:
+        """Create a new scanner
+
+        Args:
+            name: Name of the new scanner
+            host: Hostname or IP address of the scanner
+            port: Port of the scanner
+            scanner_type: Type of the scanner
+            credential_id: UUID of client certificate credential for the
+                scanner
+            ca_pub: Certificate of CA to verify scanner certificate
+            comment: Comment for the scanner
+            relay_host: Hostname or IP address of the scanner relay
+            relay_port: Port of the scanner relay
+        """
+        return self._send_request_and_transform_response(
+            Scanners.create_scanner(
+                name,
+                host,
+                port,
+                scanner_type,
+                credential_id,
+                ca_pub=ca_pub,
+                comment=comment,
+                relay_host=relay_host,
+                relay_port=relay_port,
+            )
+        )
+
+    def modify_scanner(  # type:ignore[override]
+        self,
+        scanner_id: EntityID,
+        *,
+        name: Optional[str] = None,
+        host: Optional[str] = None,
+        port: Optional[int] = None,
+        scanner_type: Optional[ScannerType] = None,
+        credential_id: Optional[EntityID] = None,
+        ca_pub: Optional[str] = None,
+        comment: Optional[str] = None,
+        relay_host: Optional[str] = None,
+        relay_port: Optional[Union[str, int]] = None,
+    ) -> T:
+        """Modify an existing scanner
+
+        Args:
+            scanner_id: UUID of the scanner to modify
+            name: New name of the scanner
+            host: New hostname or IP address of the scanner
+            port: New port of the scanner
+            scanner_type: New type of the scanner
+            credential_id: New UUID of client certificate credential for the
+                scanner
+            ca_pub: New certificate of CA to verify scanner certificate
+            comment: New comment for the scanner
+            relay_host: Hostname or IP address of the scanner relay
+            relay_port: Port of the scanner relay
+        """
+        return self._send_request_and_transform_response(
+            Scanners.modify_scanner(
+                scanner_id,
+                name=name,
+                host=host,
+                port=port,
+                scanner_type=scanner_type,
+                credential_id=credential_id,
+                ca_pub=ca_pub,
+                comment=comment,
+                relay_host=relay_host,
+                relay_port=relay_port,
+            )
+        )
+
+    def get_scanners(
+        self,
+        *,
+        filter_string: Optional[str] = None,
+        filter_id: Optional[EntityID] = None,
+        trash: Optional[bool] = None,
+        details: Optional[bool] = None,
+    ) -> T:
+        """Request a list of scanners
+
+        Args:
+            filter_string: Filter term to use for the query
+            filter_id: UUID of an existing filter to use for the query
+            trash: Whether to get the trashcan scanners instead
+            details: Whether to include extra details like tasks using this
+                scanner
+        """
+        return self._send_request_and_transform_response(
+            Scanners.get_scanners(
+                filter_string=filter_string,
+                filter_id=filter_id,
+                trash=trash,
+                details=details,
+            )
+        )
+
+    def get_scanner(self, scanner_id: EntityID) -> T:
+        """Request a single scanner
+
+        Args:
+            scanner_id: UUID of an existing scanner
+        """
+        return self._send_request_and_transform_response(
+            Scanners.get_scanner(scanner_id)
+        )
+
+    def verify_scanner(self, scanner_id: EntityID) -> T:
+        """Verify an existing scanner
+
+        Args:
+            scanner_id: UUID of an existing scanner
+        """
+        return self._send_request_and_transform_response(
+            Scanners.verify_scanner(scanner_id)
+        )
+
+    def clone_scanner(self, scanner_id: EntityID) -> T:
+        """Clone an existing scanner
+
+        Args:
+            scanner_id: UUID of an existing scanner
+        """
+        return self._send_request_and_transform_response(
+            Scanners.clone_scanner(scanner_id)
+        )
+
+    def delete_scanner(
+        self, scanner_id: EntityID, ultimate: Optional[bool] = False
+    ) -> T:
+        """Delete an existing scanner
+
+        Args:
+            scanner_id: UUID of an existing scanner
+            ultimate: Whether to remove entirely, or to the trashcan.
+        """
+        return self._send_request_and_transform_response(
+            Scanners.delete_scanner(scanner_id, ultimate=ultimate)
+        )

{python_gvm-26.1.1 → python_gvm-26.2.0}/gvm/protocols/gmp/requests/v226/_reports.py

@@ -41,6 +41,7 @@ class Reports:
         filter_id: Optional[str] = None,
         delta_report_id: Optional[EntityID] = None,
         report_format_id: Optional[Union[str, ReportFormatType]] = None,
+        report_config_id: Optional[str] = None,
         ignore_pagination: Optional[bool] = None,
         details: Optional[bool] = True,
     ) -> Request:
@@ -53,6 +54,7 @@ class Reports:
             delta_report_id: UUID of an existing report to compare report to.
             report_format_id: UUID of report format to use
                               or ReportFormatType (enum)
+            report_config_id: UUID of report format config to use
             ignore_pagination: Whether to ignore the filter terms "first" and
                 "rows".
             details: Request additional report information details
@@ -76,6 +78,9 @@ class Reports:
         if report_format_id:
             cmd.set_attribute("format_id", str(report_format_id))
 
+        if report_config_id:
+            cmd.set_attribute("config_id", str(report_config_id))
+
         if ignore_pagination is not None:
             cmd.set_attribute("ignore_pagination", to_bool(ignore_pagination))