ipfixprobe - introduce process PHISTS plugin

Author: Pavel Siska

src/plugins/process/CMakeLists.txt

@@ -8,3 +8,4 @@ add_subdirectory(vlan)
 add_subdirectory(flowHash)
 add_subdirectory(osquery)
 add_subdirectory(idpContent)
+add_subdirectory(phists)

src/plugins/process/phists/CMakeLists.txt

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

src/plugins/process/phists/README.md

@@ -1,29 +1,13 @@
 /**
- * \file phists.cpp
- * \brief Plugin for parsing phists traffic.
- * \author Karel Hynek <[email protected]>
- * \date 2021
- */
-/*
- * Copyright (C) 2021 CESNET
- *
- * LICENSE TERMS
- *
- * 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.
- *
+ * @file
+ * @brief Plugin for parsing phists traffic.
+ * @author Karel Hynek <[email protected]>
+ * @author Pavel Siska <[email protected]>
+ * @date 2025
  *
+ * Copyright (c) 2025 CESNET
  *
+ * SPDX-License-Identifier: BSD-3-Clause
  */
 
 #include "phists.hpp"
@@ -35,18 +19,25 @@
 #include <string>
 #include <vector>
 
+#include <ipfixprobe/pluginFactory/pluginManifest.hpp>
+#include <ipfixprobe/pluginFactory/pluginRegistrar.hpp>
 #include <math.h>
 
 namespace ipxp {
 
-int RecordExtPHISTS::REGISTERED_ID = -1;
+int RecordExtPHISTS::REGISTERED_ID = ProcessPluginIDGenerator::instance().generatePluginID();
 
-__attribute__((constructor)) static void register_this_plugin()
-{
-	static PluginRecord rec = PluginRecord("phists", []() { return new PHISTSPlugin(); });
-	register_plugin(&rec);
-	RecordExtPHISTS::REGISTERED_ID = register_extension();
-}
+static const PluginManifest phistsPluginManifest = {
+	.name = "phists",
+	.description = "Phists process plugin for parsing phists traffic.",
+	.pluginVersion = "1.0.0",
+	.apiVersion = "1.0.0",
+	.usage =
+		[]() {
+			PHISTSOptParser parser;
+			parser.usage(std::cout);
+		},
+};
 
 #define PHISTS_INCLUDE_ZEROS_OPT "includezeros"
 
@@ -60,9 +51,10 @@ const uint32_t PHISTSPlugin::log2_lookup32[32]
 	= {0, 9,  1,  10, 13, 21, 2,  29, 11, 14, 16, 18, 22, 25, 3, 30,
 	   8, 12, 20, 28, 15, 17, 24, 7,  19, 27, 23, 6,  26, 5,  4, 31};
 
-PHISTSPlugin::PHISTSPlugin()
+PHISTSPlugin::PHISTSPlugin(const std::string& params)
 	: use_zeros(false)
 {
+	init(params.c_str());
 }
 
 PHISTSPlugin::~PHISTSPlugin()
@@ -175,4 +167,7 @@ int PHISTSPlugin::post_update(Flow& rec, const Packet& pkt)
 	return 0;
 }
 
+static const PluginRegistrar<PHISTSPlugin, ProcessPluginFactory>
+	phistsRegistrar(phistsPluginManifest);
+
 } // namespace ipxp

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

@@ -1,33 +1,16 @@
 /**
- * \file phists.hpp
- * \brief Plugin for parsing phists traffic.
- * \author Karel Hynek <[email protected]>
- * \date 2021
- */
-/*
- * Copyright (C) 2021 CESNET
- *
- * LICENSE TERMS
- *
- * 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.
- *
+ * @file
+ * @brief Plugin for parsing phists traffic.
+ * @author Karel Hynek <[email protected]>
+ * @author Pavel Siska <[email protected]>
+ * @date 2025
  *
+ * Copyright (c) 2025 CESNET
  *
+ * SPDX-License-Identifier: BSD-3-Clause
  */
 
-#ifndef IPXP_PROCESS_PHISTS_HPP
-#define IPXP_PROCESS_PHISTS_HPP
+#pragma once
 
 #include <limits>
 #include <sstream>
@@ -41,7 +24,7 @@
 #include <ipfixprobe/ipfix-basiclist.hpp>
 #include <ipfixprobe/ipfix-elements.hpp>
 #include <ipfixprobe/packet.hpp>
-#include <ipfixprobe/process.hpp>
+#include <ipfixprobe/processPlugin.hpp>
 
 namespace ipxp {
 
@@ -200,7 +183,7 @@ struct RecordExtPHISTS : public RecordExt {
  */
 class PHISTSPlugin : public ProcessPlugin {
 public:
-	PHISTSPlugin();
+	PHISTSPlugin(const std::string& params);
 	~PHISTSPlugin();
 	void init(const char* params);
 	void close();
@@ -242,4 +225,3 @@ class PHISTSPlugin : public ProcessPlugin {
 };
 
 } // namespace ipxp
-#endif /* IPXP_PROCESS_PHISTS_HPP */