ipfixprobe - introduce process SIP plugin

Author: Pavel Siska

src/plugins/process/CMakeLists.txt

@@ -10,3 +10,4 @@ add_subdirectory(osquery)
 add_subdirectory(idpContent)
 add_subdirectory(phists)
 add_subdirectory(pstats)
+add_subdirectory(sip)

src/plugins/process/sip/CMakeLists.txt

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

src/plugins/process/sip/README.md

@@ -1,31 +1,16 @@
 /**
- * \file sip.cpp
- * \author Tomas Jansky <[email protected]>
- * \date 2015
- * \date 2016
- */
-/*
- * Copyright (C) 2015-2016 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 sip traffic.
+ * @author Tomas Jansky <[email protected]>
+ * @date 2025
  *
+ * Copyright (c) 2025 CESNET
  *
+ * SPDX-License-Identifier: BSD-3-Clause
  */
 
+#include "sip.hpp"
+
 #include <cstdlib>
 #include <cstring>
 #include <iostream>
@@ -34,25 +19,28 @@
 #include <unirec/unirec.h>
 #endif
 
-#include "sip.hpp"
+#include <ipfixprobe/pluginFactory/pluginManifest.hpp>
+#include <ipfixprobe/pluginFactory/pluginRegistrar.hpp>
 
 namespace ipxp {
 
-int RecordExtSIP::REGISTERED_ID = -1;
+int RecordExtSIP::REGISTERED_ID = ProcessPluginIDGenerator::instance().generatePluginID();
 
-__attribute__((constructor)) static void register_this_plugin()
-{
-	static PluginRecord rec = PluginRecord("sip", []() { return new SIPPlugin(); });
-	register_plugin(&rec);
-	RecordExtSIP::REGISTERED_ID = register_extension();
-}
+static const PluginManifest sipPluginManifest = {
+	.name = "sip",
+	.description = "Sip process plugin for parsing sip traffic.",
+	.pluginVersion = "1.0.0",
+	.apiVersion = "1.0.0",
+	.usage = nullptr,
+};
 
-SIPPlugin::SIPPlugin()
+SIPPlugin::SIPPlugin(const std::string& params)
 	: requests(0)
 	, responses(0)
 	, total(0)
 	, flow_flush(false)
 {
+	(void) params;
 }
 
 SIPPlugin::~SIPPlugin()
@@ -620,4 +608,6 @@ int SIPPlugin::parser_process_sip(const Packet& pkt, RecordExtSIP* sip_data)
 	return 0;
 }
 
+static const PluginRegistrar<SIPPlugin, ProcessPluginFactory> sipRegistrar(sipPluginManifest);
+
 } // namespace ipxp

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

@@ -1,33 +1,15 @@
 /**
- * \file sip.hpp
- * \author Tomas Jansky <[email protected]>
- * \date 2015
- * \date 2016
- */
-/*
- * Copyright (C) 2015-2016 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 sip traffic.
+ * @author Tomas Jansky <[email protected]>
+ * @date 2025
  *
+ * Copyright (c) 2025 CESNET
  *
+ * SPDX-License-Identifier: BSD-3-Clause
  */
 
-#ifndef IPXP_PROCESS_SIP_HPP
-#define IPXP_PROCESS_SIP_HPP
+#pragma once
 
 #include <cstdlib>
 #include <cstring>
@@ -41,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 {
 
@@ -483,7 +465,7 @@ struct RecordExtSIP : public RecordExt {
 
 class SIPPlugin : public ProcessPlugin {
 public:
-	SIPPlugin();
+	SIPPlugin(const std::string& params);
 	~SIPPlugin();
 	void init(const char* params);
 	void close();
@@ -524,4 +506,3 @@ class SIPPlugin : public ProcessPlugin {
 };
 
 } // namespace ipxp
-#endif /* IPXP_PROCESS_SIP_HPP */