ipfixprobe - introduce process MQTT plugin

Author: Pavel Siska

src/plugins/process/CMakeLists.txt

@@ -15,3 +15,4 @@ add_subdirectory(ovpn)
 add_subdirectory(wg)
 add_subdirectory(ssdp)
 add_subdirectory(ssaDetector)
+add_subdirectory(mqtt)

src/plugins/process/mqtt/CMakeLists.txt

@@ -0,0 +1,19 @@
+project(ipfixprobe-process-mqtt VERSION 1.0.0 DESCRIPTION "ipfixprobe-process-mqtt plugin")
+
+add_library(ipfixprobe-process-mqtt MODULE
+    src/mqtt.cpp
+    src/mqtt.hpp
+)
+
+set_target_properties(ipfixprobe-process-mqtt PROPERTIES
+    CXX_VISIBILITY_PRESET hidden
+    VISIBILITY_INLINES_HIDDEN YES
+)
+
+target_include_directories(ipfixprobe-process-mqtt PRIVATE 
+	${CMAKE_SOURCE_DIR}/include/
+)
+
+install(TARGETS ipfixprobe-process-mqtt
+    LIBRARY DESTINATION "${INSTALL_DIR_LIB}/ipfixprobe/process/"
+)

src/plugins/process/mqtt/README.md

@@ -1,46 +1,46 @@
 /**
- * \file mqtt.hpp
- * \brief MQTT plugin for ipfixprobe
- * \author Damir Zainullin <[email protected]>
- * \date 2024
- */
-/*
- * Copyright (C) 2023 CESNET
+ * @file
+ * @brief Plugin for parsing mqtt traffic.
+ * @author Damir Zainullin <[email protected]>
+ * @author Pavel Siska <[email protected]>
+ * @date 2025
  *
- * LICENSE TERMS
+ * Copyright (c) 2025 CESNET
  *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions
- * are met:
- * 1. Redistributions of source code must retain the above copyright
- *    notice, this list of conditions and the following disclaimer.
- * 2. Redistributions in binary form must reproduce the above copyright
- *    notice, this list of conditions and the following disclaimer in
- *    the documentation and/or other materials provided with the
- *    distribution.
- * 3. Neither the name of the Company nor the names of its contributors
- *    may be used to endorse or promote products derived from this
- *    software without specific prior written permission.
+ * SPDX-License-Identifier: BSD-3-Clause
  */
 
 #include "mqtt.hpp"
 
 #include <cstring>
 
+#include <ipfixprobe/pluginFactory/pluginManifest.hpp>
+#include <ipfixprobe/pluginFactory/pluginRegistrar.hpp>
+
 #ifdef DEBUG_MQTT
 static const bool debug_mqtt = true;
 #else
 static const bool debug_mqtt = false;
 #endif
 namespace ipxp {
 
-int RecordExtMQTT::REGISTERED_ID = -1;
-
-__attribute__((constructor)) static void register_this_plugin()
+int RecordExtMQTT::REGISTERED_ID = ProcessPluginIDGenerator::instance().generatePluginID();
+
+static const PluginManifest mqttPluginManifest = {
+	.name = "mqtt",
+	.description = "Mqtt process plugin for parsing mqtt traffic.",
+	.pluginVersion = "1.0.0",
+	.apiVersion = "1.0.0",
+	.usage =
+		[]() {
+			MQTTOptionsParser parser;
+			parser.usage(std::cout);
+		},
+};
+
+MQTTPlugin::MQTTPlugin(const std::string& params)
 {
-	static PluginRecord rec = PluginRecord("mqtt", []() { return new MQTTPlugin(); });
-	register_plugin(&rec);
-	RecordExtMQTT::REGISTERED_ID = register_extension();
+	init(params.c_str());
 }
 
 int MQTTPlugin::post_create(Flow& rec, const Packet& pkt)
@@ -233,4 +233,6 @@ ProcessPlugin* MQTTPlugin::copy()
 	return new MQTTPlugin(*this);
 }
 
+static const PluginRegistrar<MQTTPlugin, ProcessPluginFactory> mqttRegistrar(mqttPluginManifest);
+
 } // namespace ipxp

src/plugins/process/mqtt.cpp src/plugins/process/mqtt/src/mqtt.cppsrc/plugins/process/mqtt.cpp renamed to src/plugins/process/mqtt/src/mqtt.cpp

@@ -1,44 +1,30 @@
 /**
- * \file mqtt.hpp
- * \brief MQTT plugin for ipfixprobe
- * \author Damir Zainullin <[email protected]>
- * \date 2024
- */
-/*
- * Copyright (C) 2023 CESNET
+ * @file
+ * @brief Plugin for parsing mqtt traffic.
+ * @author Damir Zainullin <[email protected]>
+ * @author Pavel Siska <[email protected]>
+ * @date 2025
  *
- * LICENSE TERMS
+ * Copyright (c) 2025 CESNET
  *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions
- * are met:
- * 1. Redistributions of source code must retain the above copyright
- *    notice, this list of conditions and the following disclaimer.
- * 2. Redistributions in binary form must reproduce the above copyright
- *    notice, this list of conditions and the following disclaimer in
- *    the documentation and/or other materials provided with the
- *    distribution.
- * 3. Neither the name of the Company nor the names of its contributors
- *    may be used to endorse or promote products derived from this
- *    software without specific prior written permission.
+ * SPDX-License-Identifier: BSD-3-Clause
  */
-#ifndef CACHE_CPP_TPLUGIN_HPP
-#define CACHE_CPP_TPLUGIN_HPP
+
+#pragma once
 
 #ifdef WITH_NEMEA
 #include "fields.h"
 #endif
 
-#include "sstream"
-
 #include <cstring>
 #include <numeric>
+#include <sstream>
 
 #include <ipfixprobe/flowifc.hpp>
 #include <ipfixprobe/ipfix-basiclist.hpp>
 #include <ipfixprobe/ipfix-elements.hpp>
 #include <ipfixprobe/packet.hpp>
-#include <ipfixprobe/process.hpp>
+#include <ipfixprobe/processPlugin.hpp>
 #include <ipfixprobe/utils.hpp>
 
 namespace ipxp {
@@ -171,6 +157,7 @@ struct RecordExtMQTT : public RecordExt {
 
 class MQTTPlugin : public ProcessPlugin {
 public:
+	MQTTPlugin(const std::string& params);
 	int post_create(Flow& rec, const Packet& pkt) override;
 	int pre_update(Flow& rec, Packet& pkt) override;
 	int post_update(Flow& rec, const Packet& pkt) override;
@@ -195,5 +182,3 @@ class MQTTPlugin : public ProcessPlugin {
 };
 
 } // namespace ipxp
-
-#endif // CACHE_CPP_TPLUGIN_HPP