ipfixprobe - introduce process SSADETECTOR plugin

Author: Pavel Siska

src/plugins/process/CMakeLists.txt

@@ -14,3 +14,4 @@ add_subdirectory(sip)
 add_subdirectory(ovpn)
 add_subdirectory(wg)
 add_subdirectory(ssdp)
+add_subdirectory(ssaDetector)

src/plugins/process/ssaDetector/CMakeLists.txt

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

src/plugins/process/ssaDetector/README.md

@@ -1,54 +1,45 @@
 /**
- * \file ssadetector.cpp
- * \brief Plugin for detecting ssa sequence.
- * \author Jan Jirák [email protected]
- * \author Karel Hynek [email protected]
- * \date 2023
- */
-/*
- * Copyright (C) 2023 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 vpn_automaton traffic.
+ * @author Karel Hynek [email protected]
+ * @author Jan Jirák [email protected]
+ * @author Pavel Siska <[email protected]>
+ * @date 2025
  *
+ * Copyright (c) 2025 CESNET
  *
+ * SPDX-License-Identifier: BSD-3-Clause
  */
 
 #include "ssadetector.hpp"
 
 #include <iostream>
 
+#include <ipfixprobe/pluginFactory/pluginManifest.hpp>
+#include <ipfixprobe/pluginFactory/pluginRegistrar.hpp>
+
 namespace ipxp {
 
-int RecordExtSSADetector::REGISTERED_ID = -1;
+int RecordExtSSADetector::REGISTERED_ID = ProcessPluginIDGenerator::instance().generatePluginID();
+
+static const PluginManifest ssadetectorPluginManifest = {
+	.name = "ssadetector",
+	.description = "Ssadetector process plugin for parsing vpn_automaton traffic.",
+	.pluginVersion = "1.0.0",
+	.apiVersion = "1.0.0",
+	.usage = nullptr,
+};
 
-__attribute__((constructor)) static void register_this_plugin()
+SSADetectorPlugin::SSADetectorPlugin(const std::string& params)
 {
-	static PluginRecord rec = PluginRecord("ssadetector", []() { return new SSADetectorPlugin(); });
-	register_plugin(&rec);
-	RecordExtSSADetector::REGISTERED_ID = register_extension();
+	init(params.c_str());
 }
 
-SSADetectorPlugin::SSADetectorPlugin()
+SSADetectorPlugin::~SSADetectorPlugin()
 {
 	close();
 }
 
-SSADetectorPlugin::~SSADetectorPlugin() {}
-
 void SSADetectorPlugin::init(const char* params) {}
 
 void SSADetectorPlugin::close() {}
@@ -277,4 +268,7 @@ int8_t RecordExtSSADetector::pkt_table::get_idx_from_len(uint16_t len)
 	return std::max(int(len) - MIN_PKT_SIZE, 0);
 }
 
+static const PluginRegistrar<SSADetectorPlugin, ProcessPluginFactory>
+	ssadetectorRegistrar(ssadetectorPluginManifest);
+
 } // namespace ipxp

src/plugins/process/ssadetector.cpp …/process/ssaDetector/src/ssadetector.cppsrc/plugins/process/ssadetector.cpp renamed to src/plugins/process/ssaDetector/src/ssadetector.cpp src/plugins/process/ssadetector.cpp renamed to src/plugins/process/ssaDetector/src/ssadetector.cpp

@@ -1,34 +1,17 @@
 /**
- * \file ssadetector.hpp
- * \brief Plugin for parsing vpn_automaton traffic.
- * \author Jan Jirák [email protected]
- * \author Karel Hynek [email protected]
- * \date 2023
- */
-/*
- * Copyright (C) 2023 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 vpn_automaton traffic.
+ * @author Karel Hynek [email protected]
+ * @author Jan Jirák [email protected]
+ * @author Pavel Siska <[email protected]>
+ * @date 2025
  *
+ * Copyright (c) 2025 CESNET
  *
+ * SPDX-License-Identifier: BSD-3-Clause
  */
 
-#ifndef IPXP_SSADETECTOR_HPP
-#define IPXP_SSADETECTOR_HPP
+#pragma once
 
 #include <cstring>
 #include <sstream>
@@ -40,7 +23,7 @@
 #include <ipfixprobe/flowifc.hpp>
 #include <ipfixprobe/ipfix-elements.hpp>
 #include <ipfixprobe/packet.hpp>
-#include <ipfixprobe/process.hpp>
+#include <ipfixprobe/processPlugin.hpp>
 
 namespace ipxp {
 
@@ -160,7 +143,7 @@ struct RecordExtSSADetector : public RecordExt {
  */
 class SSADetectorPlugin : public ProcessPlugin {
 public:
-	SSADetectorPlugin();
+	SSADetectorPlugin(const std::string& params);
 	~SSADetectorPlugin();
 	void init(const char* params);
 	void close();
@@ -192,4 +175,3 @@ class SSADetectorPlugin : public ProcessPlugin {
 };
 
 } // namespace ipxp
-#endif /* IPXP_SSADETECTOR_HPP */