ipfixprobe - introduce process SMTP plugin

Author: Pavel Siska

src/plugins/process/CMakeLists.txt

@@ -16,6 +16,7 @@ add_subdirectory(dns)
 add_subdirectory(dnssd)
 add_subdirectory(netbios)
 add_subdirectory(passiveDns)
+add_subdirectory(smtp)
 
 if (ENABLE_PROCESS_EXPERIMENTAL)
 	add_subdirectory(sip)

src/plugins/process/smtp/CMakeLists.txt

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

src/plugins/process/smtp/README.md

@@ -1,29 +1,13 @@
 /**
- * \file smtp.cpp
- * \brief Plugin for parsing smtp traffic.
- * \author Jiri Havranek <[email protected]>
- * \date 2018
- */
-/*
- * Copyright (C) 2018 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 smtp traffic.
+ * @author Jiri Havranek <[email protected]>
+ * @author Pavel Siska <[email protected]>
+ * @date 2025
  *
+ * Copyright (c) 2025 CESNET
  *
+ * SPDX-License-Identifier: BSD-3-Clause
  */
 
 #include "smtp.hpp"
@@ -34,32 +18,39 @@
 #include <iostream>
 
 #include <ctype.h>
+#include <ipfixprobe/pluginFactory/pluginManifest.hpp>
+#include <ipfixprobe/pluginFactory/pluginRegistrar.hpp>
 
 namespace ipxp {
 
-int RecordExtSMTP::REGISTERED_ID = -1;
+int RecordExtSMTP::REGISTERED_ID = ProcessPluginIDGenerator::instance().generatePluginID();
 
-__attribute__((constructor)) static void register_this_plugin()
-{
-	static PluginRecord rec = PluginRecord("smtp", []() { return new SMTPPlugin(); });
-	register_plugin(&rec);
-	RecordExtSMTP::REGISTERED_ID = register_extension();
-}
+static const PluginManifest smtpPluginManifest = {
+	.name = "smtp",
+	.description = "Smtp process plugin for parsing smtp traffic.",
+	.pluginVersion = "1.0.0",
+	.apiVersion = "1.0.0",
+	.usage = nullptr,
+};
 
-SMTPPlugin::SMTPPlugin()
+SMTPPlugin::SMTPPlugin(const std::string& params)
 	: ext_ptr(nullptr)
 	, total(0)
 	, replies_cnt(0)
 	, commands_cnt(0)
 {
+	init(params.c_str());
 }
 
 SMTPPlugin::~SMTPPlugin()
 {
 	close();
 }
 
-void SMTPPlugin::init(const char* params) {}
+void SMTPPlugin::init(const char* params)
+{
+	(void) params;
+}
 
 void SMTPPlugin::close() {}
 
@@ -416,4 +407,6 @@ void SMTPPlugin::finish(bool print_stats)
 	}
 }
 
+static const PluginRegistrar<SMTPPlugin, ProcessPluginFactory> smtpRegistrar(smtpPluginManifest);
+
 } // namespace ipxp

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

@@ -1,33 +1,16 @@
 /**
- * \file smtp.hpp
- * \brief Plugin for parsing smtp traffic.
- * \author Jiri Havranek <[email protected]>
- * \date 2018
- */
-/*
- * Copyright (C) 2018 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 smtp traffic.
+ * @author Jiri Havranek <[email protected]>
+ * @author Pavel Siska <[email protected]>
+ * @date 2025
  *
+ * Copyright (c) 2025 CESNET
  *
+ * SPDX-License-Identifier: BSD-3-Clause
  */
 
-#ifndef IPXP_PROCESS_SMTP_HPP
-#define IPXP_PROCESS_SMTP_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 {
 
@@ -223,7 +206,7 @@ struct RecordExtSMTP : public RecordExt {
  */
 class SMTPPlugin : public ProcessPlugin {
 public:
-	SMTPPlugin();
+	SMTPPlugin(const std::string& params);
 	~SMTPPlugin();
 	void init(const char* params);
 	void close();
@@ -250,4 +233,3 @@ class SMTPPlugin : public ProcessPlugin {
 };
 
 } // namespace ipxp
-#endif /* IPXP_PROCESS_SMTP_HPP */