ipfixprobe - introduce process TLS plugin

Author: Pavel Siska

src/plugins/process/CMakeLists.txt

@@ -23,3 +23,4 @@ add_subdirectory(netbios)
 add_subdirectory(passiveDns)
 add_subdirectory(smtp)
 add_subdirectory(quic)
+add_subdirectory(tls)

src/plugins/process/tls/CMakeLists.txt

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

src/plugins/process/tls/README.md

@@ -1,41 +1,40 @@
-/* SPDX-License-Identifier: BSD-3-Clause
- * Copyright (C) 2018-2022, CESNET z.s.p.o.
- */
-
 /**
- * \file tls.cpp
- * \brief Plugin for enriching flows for tls data.
- * \author Jiri Havranek <[email protected]>
- * \author Ondrej Sedlacek <[email protected]>
- * \author Karel Hynek <[email protected]>
- * \author Andrej Lukacovic [email protected]
- * \author Jonas Mücke <[email protected]>
- * \date 2018-2022
+ * @file
+ * @brief Plugin for enriching flows for tls data.
+ * @author Jiri Havranek <[email protected]>
+ * @author Karel Hynek <[email protected]>
+ * @author Andrej Lukacovic [email protected]
+ * @author Jonas Mücke <[email protected]>
+ * @author Pavel Siska <[email protected]>
+ *
+ * Copyright (c) 2025 CESNET
+ *
+ * SPDX-License-Identifier: BSD-3-Clause
  */
-
-#include "tls.hpp"
-
 #include "md5.hpp"
 #include "sha256.hpp"
+#include "tls.hpp"
 
 #include <algorithm>
 #include <cctype>
 #include <functional>
 #include <iostream>
 #include <numeric>
 
+#include <ipfixprobe/pluginFactory/pluginManifest.hpp>
+#include <ipfixprobe/pluginFactory/pluginRegistrar.hpp>
 #include <stdio.h>
 
 namespace ipxp {
-int RecordExtTLS::REGISTERED_ID = -1;
-
-__attribute__((constructor)) static void register_this_plugin()
-{
-	static PluginRecord rec = PluginRecord("tls", []() { return new TLSPlugin(); });
+int RecordExtTLS::REGISTERED_ID = ProcessPluginIDGenerator::instance().generatePluginID();
 
-	register_plugin(&rec);
-	RecordExtTLS::REGISTERED_ID = register_extension();
-}
+static const PluginManifest tlsPluginManifest = {
+	.name = "tls",
+	.description = "Tls process plugin for parsing tls traffic.",
+	.pluginVersion = "1.0.0",
+	.apiVersion = "1.0.0",
+	.usage = nullptr,
+};
 
 // Print debug message if debugging is allowed.
 #ifdef DEBUG_TLS
@@ -51,6 +50,11 @@ __attribute__((constructor)) static void register_this_plugin()
 #define DEBUG_CODE(code)
 #endif
 
+TLSPlugin::TLSPlugin(const std::string& params)
+{
+	init(params.c_str());
+}
+
 OptionsParser* TLSPlugin::get_parser() const
 {
 	return new OptionsParser("tls", "Parse SNI from TLS traffic");
@@ -412,4 +416,7 @@ void TLSPlugin::finish(bool print_stats)
 		std::cout << "   Parsed SNI: " << parsed_sni << std::endl;
 	}
 }
+
+static const PluginRegistrar<TLSPlugin, ProcessPluginFactory> tlsRegistrar(tlsPluginManifest);
+
 } // namespace ipxp

src/plugins/process/md5.cpp src/plugins/process/tls/src/md5.cppsrc/plugins/process/md5.cpp renamed to src/plugins/process/tls/src/md5.cpp

@@ -1,19 +1,18 @@
-/* SPDX-License-Identifier: BSD-3-Clause
- * Copyright (C) 2018-2022, CESNET z.s.p.o.
- */
-
 /**
- * \file tls.hpp
- * \brief Plugin for enriching flows for tls data.
- * \author Jiri Havranek <[email protected]>
- * \author Karel Hynek <[email protected]>
- * \author Andrej Lukacovic [email protected]
- * \author Jonas Mücke <[email protected]>
- * \date 2022
+ * @file
+ * @brief Plugin for enriching flows for tls data.
+ * @author Jiri Havranek <[email protected]>
+ * @author Karel Hynek <[email protected]>
+ * @author Andrej Lukacovic [email protected]
+ * @author Jonas Mücke <[email protected]>
+ * @author Pavel Siska <[email protected]>
+ *
+ * Copyright (c) 2025 CESNET
+ *
+ * SPDX-License-Identifier: BSD-3-Clause
  */
 
-#ifndef IPXP_PROCESS_TLS_HPP
-#define IPXP_PROCESS_TLS_HPP
+#pragma once
 
 #include <array>
 #include <cstring>
@@ -27,9 +26,9 @@
 #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>
-#include <process/tls_parser.hpp>
+#include <tlsParser/tls_parser.hpp>
 
 #ifdef WITH_NEMEA
 #include "fields.h"
@@ -191,6 +190,7 @@ struct RecordExtTLS : public RecordExt {
  */
 class TLSPlugin : public ProcessPlugin {
 public:
+	TLSPlugin(const std::string& params);
 	~TLSPlugin() override;
 	void init(const char* params) override;
 	void close() override;
@@ -214,5 +214,5 @@ class TLSPlugin : public ProcessPlugin {
 	TLSParser tls_parser {};
 	uint32_t parsed_sni {0};
 };
+
 } // namespace ipxp
-#endif /* IPXP_PROCESS_TLS_HPP */