python-gvm 24.1.0__py3-none-any.whl → 24.3.0__py3-none-any.whl

gvm/__init__.py

@@ -1,20 +1,7 @@
-# -*- coding: utf-8 -*-
-# Copyright (C) 2018-2022 Greenbone AG
+# SPDX-FileCopyrightText: 2018-2024 Greenbone AG
 #
 # SPDX-License-Identifier: GPL-3.0-or-later
 #
-# This program is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-#
-# This program is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with this program.  If not, see <http://www.gnu.org/licenses/>.
 """
 Main module of python-gvm.
 """

gvm/__version__.py

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

gvm/_enum.py

@@ -0,0 +1,38 @@
+# SPDX-FileCopyrightText: 2024 Greenbone AG
+#
+# SPDX-License-Identifier: GPL-3.0-or-later
+#
+
+from enum import Enum as PythonEnum
+from typing import Optional
+
+from typing_extensions import Self
+
+from gvm.errors import InvalidArgument
+
+
+class Enum(PythonEnum):
+    """
+    Base class for Enums in python-gvm
+    """
+
+    @classmethod
+    def from_string(
+        cls,
+        value: Optional[str],
+    ) -> Optional[Self]:
+        """
+        Convert a string value into an Enum instance
+
+        If value is None or empty None is returned
+        """
+        if not value:
+            return None
+
+        try:
+            return cls[value.replace(" ", "_").upper()]
+        except KeyError:
+            raise InvalidArgument(
+                f"Invalid argument {value} for {cls.__name__}.from_string. "
+                f"Allowed values are {','.join(e.name for e in cls)}."
+            ) from None

gvm/connections.py

@@ -1,20 +1,7 @@
-# -*- coding: utf-8 -*-
-# Copyright (C) 2018-2022 Greenbone AG
+# SPDX-FileCopyrightText: 2018-2024 Greenbone AG
 #
 # SPDX-License-Identifier: GPL-3.0-or-later
 #
-# This program is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-#
-# This program is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with this program.  If not, see <http://www.gnu.org/licenses/>.
 """
 Module for connections to GVM server daemons like gvmd and ospd.
 """
@@ -26,11 +13,14 @@ import socket as socketlib
 import ssl
 import sys
 import time
+from abc import ABC, abstractmethod
+from os import PathLike
 from pathlib import Path
-from typing import Optional, Union
+from typing import Optional, Protocol, Union, runtime_checkable
 
 import paramiko
 import paramiko.ssh_exception
+import paramiko.transport
 from lxml import etree
 
 from gvm.errors import GvmError
@@ -49,13 +39,28 @@ DEFAULT_HOSTNAME = "127.0.0.1"
 DEFAULT_KNOWN_HOSTS_FILE = ".ssh/known_hosts"
 MAX_SSH_DATA_LENGTH = 4095
 
+Data = Union[str, bytes]
+
+
+@runtime_checkable
+class GvmConnection(Protocol):
+    def connect(self) -> None: ...
+
+    def disconnect(self) -> None: ...
+
+    def send(self, data: Data) -> None: ...
+
+    def read(self) -> str: ...
+
+    def finish_send(self): ...
+
 
 class XmlReader:
     """
     Read a XML command until its closing element
     """
 
-    def _start_xml(self):
+    def start_xml(self) -> None:
         self._first_element = None
         # act on start and end element events and
         # allow huge text data (for report content)
@@ -63,7 +68,7 @@ class XmlReader:
             events=("start", "end"), huge_tree=True
         )
 
-    def _is_end_xml(self):
+    def is_end_xml(self) -> bool:
         for action, obj in self._parser.read_events():
             if not self._first_element and action in "start":
                 self._first_element = obj.tag
@@ -76,7 +81,7 @@ class XmlReader:
                 return True
         return False
 
-    def _feed_xml(self, data):
+    def feed_xml(self, data: Data) -> None:
         try:
             self._parser.feed(data)
         except etree.ParseError as e:
@@ -86,7 +91,7 @@ class XmlReader:
             ) from None
 
 
-class GvmConnection(XmlReader):
+class AbstractGvmConnection(ABC):
     """
     Base class for establishing a connection to a remote server daemon.
 
@@ -95,18 +100,23 @@ class GvmConnection(XmlReader):
             wait indefinitely
     """
 
-    def __init__(self, timeout: Optional[int] = DEFAULT_TIMEOUT):
+    def __init__(self, timeout: Optional[Union[int, float]] = DEFAULT_TIMEOUT):
         self._socket = None
         self._timeout = timeout if timeout is not None else DEFAULT_TIMEOUT
+        self._xml_reader = XmlReader()
 
     def _read(self) -> bytes:
+        if self._socket is None:
+            raise GvmError("Socket is not connected")
+
         return self._socket.recv(BUF_SIZE)
 
-    def connect(self):
+    @abstractmethod
+    def connect(self) -> None:
         """Establish a connection to a remote server"""
         raise NotImplementedError
 
-    def send(self, data: Union[bytes, str]) -> None:
+    def send(self, data: Data) -> None:
         """Send data to the connected remote server
 
         Arguments:
@@ -117,9 +127,9 @@ class GvmConnection(XmlReader):
             raise GvmError("Socket is not connected")
 
         if isinstance(data, str):
-            return self._socket.sendall(data.encode())
+            self._socket.sendall(data.encode())
         else:
-            return self._socket.sendall(data)
+            self._socket.sendall(data)
 
     def read(self) -> str:
         """Read data from the remote server
@@ -129,12 +139,11 @@ class GvmConnection(XmlReader):
         """
         response = ""
 
-        self._start_xml()
+        self._xml_reader.start_xml()
 
-        if self._timeout is not None:
-            now = time.time()
-
-            break_timeout = now + self._timeout
+        break_timeout = (
+            time.time() + self._timeout if self._timeout is not None else None
+        )
 
         while True:
             data = self._read()
@@ -143,19 +152,19 @@ class GvmConnection(XmlReader):
                 # Connection was closed by server
                 raise GvmError("Remote closed the connection")
 
-            self._feed_xml(data)
+            self._xml_reader.feed_xml(data)
 
             response += data.decode("utf-8", errors="ignore")
 
-            if self._is_end_xml():
+            if self._xml_reader.is_end_xml():
                 break
 
-            if time.time() > break_timeout:
+            if break_timeout and time.time() > break_timeout:
                 raise GvmError("Timeout while reading the response")
 
         return response
 
-    def disconnect(self):
+    def disconnect(self) -> None:
         """Disconnect and close the connection to the remote server"""
         try:
             if self._socket is not None:
@@ -165,11 +174,12 @@ class GvmConnection(XmlReader):
 
     def finish_send(self):
         """Indicate to the remote server you are done with sending data"""
-        # shutdown socket for sending. only allow reading data afterwards
-        self._socket.shutdown(socketlib.SHUT_WR)
+        if self._socket is not None:
+            # shutdown socket for sending. only allow reading data afterwards
+            self._socket.shutdown(socketlib.SHUT_WR)
 
 
-class SSHConnection(GvmConnection):
+class SSHConnection(AbstractGvmConnection):
     """
     SSH Class to connect, read and write from GVM via SSH
 
@@ -179,22 +189,21 @@ class SSHConnection(GvmConnection):
             127.0.0.1.
         port: Port of the remote SSH server. Default is port 22.
         username: Username to use for SSH login. Default is "gmp".
-        password: Passwort to use for SSH login. Default is "".
+        password: Password to use for SSH login. Default is "".
     """
 
     def __init__(
         self,
         *,
-        timeout: Optional[int] = DEFAULT_TIMEOUT,
+        timeout: Optional[Union[int, float]] = DEFAULT_TIMEOUT,
         hostname: Optional[str] = DEFAULT_HOSTNAME,
         port: Optional[int] = DEFAULT_SSH_PORT,
         username: Optional[str] = DEFAULT_SSH_USERNAME,
         password: Optional[str] = DEFAULT_SSH_PASSWORD,
-        known_hosts_file: Optional[str] = None,
+        known_hosts_file: Optional[Union[str, PathLike]] = None,
         auto_accept_host: Optional[bool] = None,
-    ):
-        super().__init__(timeout=timeout)
-
+    ) -> None:
+        super().__init__(timeout)
         self.hostname = hostname if hostname is not None else DEFAULT_HOSTNAME
         self.port = int(port) if port is not None else DEFAULT_SSH_PORT
         self.username = (
@@ -210,7 +219,7 @@ class SSHConnection(GvmConnection):
         )
         self.auto_accept_host = auto_accept_host
 
-    def _send_all(self, data) -> int:
+    def _send_all(self, data: bytes) -> int:
         """Returns the sum of sent bytes if success"""
         sent_sum = 0
         while data:
@@ -237,13 +246,15 @@ class SSHConnection(GvmConnection):
                 key,
             )
         try:
-            hostkeys.save(filename=self.known_hosts_file)
+            hostkeys.save(filename=str(self.known_hosts_file))
         except OSError as e:
             raise GvmError(
                 "Something went wrong with writing "
                 f"the known_hosts file: {e}"
             ) from None
+
         key_type = key.get_name().replace("ssh-", "").upper()
+
         logger.info(
             "Warning: Permanently added '%s' (%s) to "
             "the list of known hosts.",
@@ -260,12 +271,14 @@ class SSHConnection(GvmConnection):
             hashlib.sha256(base64.b64decode(key.get_base64())).digest()
         ).decode("utf-8")[:-1]
         key_type = key.get_name().replace("ssh-", "").upper()
+
         print(
             f"The authenticity of host '{self.hostname}' can't "
             "be established."
         )
         print(f"{key_type} key fingerprint is {sha64_fingerprint}.")
         print("Are you sure you want to continue connecting (yes/no)? ", end="")
+
         add = input()
         while True:
             if add == "yes":
@@ -277,22 +290,25 @@ class SSHConnection(GvmConnection):
                         key.get_name(),
                         key,
                     )
+
                 # ask user if the key should be added permanently
                 print(
                     f"Do you want to add {self.hostname} "
                     "to known_hosts (yes/no)? ",
                     end="",
                 )
+
                 save = input()
                 while True:
                     if save == "yes":
                         try:
-                            hostkeys.save(filename=self.known_hosts_file)
+                            hostkeys.save(filename=str(self.known_hosts_file))
                         except OSError as e:
                             raise GvmError(
                                 "Something went wrong with writing "
                                 f"the known_hosts file: {e}"
                             ) from None
+
                         logger.info(
                             "Warning: Permanently added '%s' (%s) to "
                             "the list of known hosts.",
@@ -318,7 +334,7 @@ class SSHConnection(GvmConnection):
                 print("Please type 'yes' or 'no': ", end="")
                 add = input()
 
-    def _get_remote_host_key(self):
+    def _get_remote_host_key(self) -> paramiko.PKey:
         """Get the remote host key for ssh connection"""
         try:
             tmp_socket = socketlib.socket()
@@ -355,7 +371,7 @@ class SSHConnection(GvmConnection):
         # https://stackoverflow.com/q/32945533
         try:
             # load the keys into paramiko and check if remote is in the list
-            self._socket.load_host_keys(filename=self.known_hosts_file)
+            self._socket.load_host_keys(filename=str(self.known_hosts_file))
         except OSError as e:
             if e.errno != errno.ENOENT:
                 raise GvmError(
@@ -412,10 +428,13 @@ class SSHConnection(GvmConnection):
     def _read(self) -> bytes:
         return self._stdout.channel.recv(BUF_SIZE)
 
-    def send(self, data: Union[bytes, str]) -> int:
-        return self._send_all(data)
+    def send(self, data: Data) -> None:
+        if isinstance(data, str):
+            self._send_all(data.encode())
+        else:
+            self._send_all(data)
 
-    def finish_send(self):
+    def finish_send(self) -> None:
         # shutdown socket for sending. only allow reading data afterwards
         self._stdout.channel.shutdown(socketlib.SHUT_WR)
 
@@ -434,7 +453,7 @@ class SSHConnection(GvmConnection):
             del self._socket, self._stdin, self._stdout, self._stderr
 
 
-class TLSConnection(GvmConnection):
+class TLSConnection(AbstractGvmConnection):
     """
     TLS class to connect, read and write from a remote GVM daemon via TLS
     secured socket.
@@ -466,8 +485,8 @@ class TLSConnection(GvmConnection):
         hostname: Optional[str] = DEFAULT_HOSTNAME,
         port: Optional[int] = DEFAULT_GVM_PORT,
         password: Optional[str] = None,
-        timeout: Optional[int] = DEFAULT_TIMEOUT,
-    ):
+        timeout: Optional[Union[int, float]] = DEFAULT_TIMEOUT,
+    ) -> None:
         super().__init__(timeout=timeout)
 
         self.hostname = hostname if hostname is not None else DEFAULT_HOSTNAME
@@ -505,7 +524,7 @@ class TLSConnection(GvmConnection):
 
         return sock
 
-    def connect(self):
+    def connect(self) -> None:
         self._socket = self._new_socket()
         self._socket.connect((self.hostname, int(self.port)))
 
@@ -516,10 +535,10 @@ class TLSConnection(GvmConnection):
                 self._socket = self._socket.unwrap()
         except OSError as e:
             logger.debug("Connection closing error: %s", e)
-        return super(TLSConnection, self).disconnect()
+        return super().disconnect()
 
 
-class UnixSocketConnection(GvmConnection):
+class UnixSocketConnection(AbstractGvmConnection):
     """
     UNIX-Socket class to connect, read, write from a daemon via direct
     communicating UNIX-Socket
@@ -533,7 +552,7 @@ class UnixSocketConnection(GvmConnection):
         self,
         *,
         path: Optional[str] = DEFAULT_UNIX_SOCKET_PATH,
-        timeout: Optional[int] = DEFAULT_TIMEOUT,
+        timeout: Optional[Union[int, float]] = DEFAULT_TIMEOUT,
     ) -> None:
         super().__init__(timeout=timeout)
 
@@ -572,8 +591,8 @@ class DebugConnection:
 
         logging.basicConfig(level=logging.DEBUG)
 
-        socketconnection = UnixSocketConnection(path='/var/run/gvm.sock')
-        connection = DebugConnection(socketconnection)
+        socket_connection = UnixSocketConnection(path='/var/run/gvm.sock')
+        connection = DebugConnection(socket_connection)
         gmp = Gmp(connection=connection)
 
     Arguments:
@@ -594,24 +613,24 @@ class DebugConnection:
         self.last_read_data = data
         return data
 
-    def send(self, data):
+    def send(self, data: Data) -> None:
         self.last_send_data = data
 
         logger.debug("Sending %s characters. Data %s", len(data), data)
 
         return self._connection.send(data)
 
-    def connect(self):
+    def connect(self) -> None:
         logger.debug("Connecting")
 
         return self._connection.connect()
 
-    def disconnect(self):
+    def disconnect(self) -> None:
         logger.debug("Disconnecting")
 
         return self._connection.disconnect()
 
-    def finish_send(self):
+    def finish_send(self) -> None:
         logger.debug("Finish send")
 
         self._connection.finish_send()

gvm/errors.py

@@ -1,20 +1,7 @@
-# -*- coding: utf-8 -*-
-# Copyright (C) 2018-2022 Greenbone AG
+# SPDX-FileCopyrightText: 2018-2024 Greenbone AG
 #
 # SPDX-License-Identifier: GPL-3.0-or-later
 #
-# This program is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-#
-# This program is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with this program.  If not, see <http://www.gnu.org/licenses/>.
 """
 Module for GVM errors
 """

gvm/protocols/__init__.py

@@ -1,20 +1,7 @@
-# -*- coding: utf-8 -*-
-# Copyright (C) 2018-2022 Greenbone AG
+# SPDX-FileCopyrightText: 2018-2024 Greenbone AG
 #
 # SPDX-License-Identifier: GPL-3.0-or-later
 #
-# This program is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-#
-# This program is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with this program.  If not, see <http://www.gnu.org/licenses/>.
 """
 Package for supported Greenbone Protocol versions.
 

gvm/protocols/base.py

@@ -1,20 +1,7 @@
-# -*- coding: utf-8 -*-
-# Copyright (C) 2018-2022 Greenbone AG
+# SPDX-FileCopyrightText: 2018-2024 Greenbone AG
 #
 # SPDX-License-Identifier: GPL-3.0-or-later
 #
-# This program is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-#
-# This program is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 from typing import Any, Callable, Optional
 

gvm/protocols/gmp.py

@@ -1,20 +1,7 @@
-# -*- coding: utf-8 -*-
-# Copyright (C) 2019-2022 Greenbone AG
+# SPDX-FileCopyrightText: 2019-2024 Greenbone AG
 #
 # SPDX-License-Identifier: GPL-3.0-or-later
 #
-# This program is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-#
-# This program is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 """
 Module for communication with gvmd

gvm/protocols/gmpv208/__init__.py

@@ -1,20 +1,7 @@
-# -*- coding: utf-8 -*-
-# Copyright (C) 2018-2022 Greenbone AG
+# SPDX-FileCopyrightText: 2018-2024 Greenbone AG
 #
 # SPDX-License-Identifier: GPL-3.0-or-later
 #
-# This program is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-#
-# This program is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 # pylint: disable=too-many-lines,redefined-builtin
 """

gvm/protocols/gmpv208/entities/__init__.py

@@ -1,17 +1,4 @@
-# -*- coding: utf-8 -*-
-# Copyright (C) 2021-2022 Greenbone AG
+# SPDX-FileCopyrightText: 2021-2024 Greenbone AG
 #
 # SPDX-License-Identifier: GPL-3.0-or-later
 #
-# This program is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-#
-# This program is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with this program.  If not, see <http://www.gnu.org/licenses/>.