Change: Support paho-mqtt version 1 and 2

For GOS we want to keep compatibility to paho-mqtt 1 but Kali for
example already has switched to version 2. Therefore support both
versions.

ospd_openvas/messaging/mqtt.py

@@ -5,17 +5,16 @@
 
 import json
 import logging
-
 from functools import partial
 from socket import gaierror, timeout
 from threading import Thread
 from time import sleep
 from typing import Callable, Type
 
 import paho.mqtt.client as mqtt
+from paho.mqtt import __version__ as paho_mqtt_version
 
 from ..messages.message import Message
-
 from .publisher import Publisher
 from .subscriber import Subscriber
 
@@ -26,6 +25,10 @@
 QOS_AT_LEAST_ONCE = 1
 
 
+def is_paho_mqtt_version_2() -> bool:
+    return paho_mqtt_version.startswith("2")
+
+
 class MQTTClient(mqtt.Client):
     def __init__(
         self,
@@ -36,7 +39,21 @@ def __init__(
         self._mqtt_broker_address = mqtt_broker_address
         self._mqtt_broker_port = mqtt_broker_port
 
-        super().__init__(client_id=client_id, protocol=mqtt.MQTTv5)
+        mqtt_client_args = {
+            "client_id": client_id,
+            "protocol": mqtt.MQTTv5,
+        }
+
+        if is_paho_mqtt_version_2():
+            logger.debug("Using Paho MQTT version 2")
+            # pylint: disable=no-member
+            mqtt_client_args["callback_api_version"] = (
+                mqtt.CallbackAPIVersion.VERSION1
+            )
+        else:
+            logger.debug("Using Paho MQTT version 1")
+
+        super().__init__(**mqtt_client_args)
 
         self.enable_logger()
 

pyproject.toml

@@ -50,8 +50,7 @@ packaging = ">=20.4,<25.0"
 lxml = ">=4.5.2,<6.0.0"
 defusedxml = ">=0.6,<0.8"
 deprecated = "^1.2.10"
-# use v1.x due to https://github.com/eclipse/paho.mqtt.python/issues/814
-paho-mqtt = "^1.6"
+paho-mqtt = ">=1.6,<3"
 python-gnupg = ">=0.4.8,<0.6.0"
 
 [tool.poetry.dev-dependencies]