ipfixprobe - introduce process HTTP plugin

Author: Pavel Siska

src/plugins/process/CMakeLists.txt

@@ -20,6 +20,7 @@ add_subdirectory(passiveDns)
 add_subdirectory(smtp)
 add_subdirectory(quic)
 add_subdirectory(tls)
+add_subdirectory(http)
 
 if (ENABLE_PROCESS_EXPERIMENTAL)
 	add_subdirectory(sip)

src/plugins/process/http/CMakeLists.txt

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

src/plugins/process/http/README.md

@@ -1,53 +1,40 @@
 /**
- * \file http.cpp
- * \brief Plugin for parsing HTTP traffic
- * \author Jiri Havranek <[email protected]>
- * \date 2015
- * \date 2016
- */
-/*
- * Copyright (C) 2014-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 HTTP traffic.
+ * @author Jiri Havranek <[email protected]>
+ * @author Pavel Siska <[email protected]>
+ * @date 2025
  *
+ * Copyright (c) 2025 CESNET
  *
+ * SPDX-License-Identifier: BSD-3-Clause
  */
 
+#include "common.hpp"
+#include "http.hpp"
+
 #include <cstdlib>
 #include <cstring>
 #include <iostream>
 
+#include <ipfixprobe/pluginFactory/pluginManifest.hpp>
+#include <ipfixprobe/pluginFactory/pluginRegistrar.hpp>
+
 #ifdef WITH_NEMEA
 #include <unirec/unirec.h>
 #endif
 
-#include "common.hpp"
-#include "http.hpp"
-
 namespace ipxp {
 
-int RecordExtHTTP::REGISTERED_ID = -1;
+int RecordExtHTTP::REGISTERED_ID = ProcessPluginIDGenerator::instance().generatePluginID();
 
-__attribute__((constructor)) static void register_this_plugin()
-{
-	static PluginRecord rec = PluginRecord("http", []() { return new HTTPPlugin(); });
-	register_plugin(&rec);
-	RecordExtHTTP::REGISTERED_ID = register_extension();
-}
+static const PluginManifest httpPluginManifest = {
+	.name = "http",
+	.description = "http process plugin for parsing http traffic.",
+	.pluginVersion = "1.0.0",
+	.apiVersion = "1.0.0",
+	.usage = nullptr,
+};
 
 // #define DEBUG_HTTP
 
@@ -70,21 +57,25 @@ __attribute__((constructor)) static void register_this_plugin()
 #define HTTP_SETCOOKIE_NAME_DELIMITER "="
 #define STRING_DELIMITER ";"
 
-HTTPPlugin::HTTPPlugin()
+HTTPPlugin::HTTPPlugin(const std::string& params)
 	: recPrealloc(nullptr)
 	, flow_flush(false)
 	, requests(0)
 	, responses(0)
 	, total(0)
 {
+	init(params.c_str());
 }
 
 HTTPPlugin::~HTTPPlugin()
 {
 	close();
 }
 
-void HTTPPlugin::init(const char* params) {}
+void HTTPPlugin::init(const char* params)
+{
+	(void) params;
+}
 
 void HTTPPlugin::close()
 {
@@ -154,34 +145,6 @@ void HTTPPlugin::finish(bool print_stats)
 	}
 }
 
-/**
- * \brief Copy string and append \0 character.
- * NOTE: function removes any CR chars at the end of string.
- * \param [in] dst Destination buffer.
- * \param [in] size Size of destination buffer.
- * \param [in] begin Ptr to begin of source string.
- * \param [in] end Ptr to end of source string.
- */
-void copy_str(char* dst, ssize_t size, const char* begin, const char* end)
-{
-	ssize_t len = end - begin;
-	if (len >= size) {
-		len = size - 1;
-	}
-
-	memcpy(dst, begin, len);
-
-	if (len >= 1 && dst[len - 1] == '\n') {
-		len--;
-	}
-
-	if (len >= 1 && dst[len - 1] == '\r') {
-		len--;
-	}
-
-	dst[len] = 0;
-}
-
 /**
  * \brief Add delimiter and string at the end of destination buffer if is it empty add only string
  * and append \0 character. NOTE: function removes any CR chars at the end of string. \param [in]
@@ -650,4 +613,6 @@ void HTTPPlugin::add_ext_http_response(const char* data, int payload_len, Flow&
 	}
 }
 
+static const PluginRegistrar<HTTPPlugin, ProcessPluginFactory> httpRegistrar(httpPluginManifest);
+
 } // namespace ipxp

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

@@ -1,34 +1,16 @@
 /**
- * \file http.hpp
- * \brief Plugin for parsing HTTP traffic
- * \author Jiri Havranek <[email protected]>
- * \date 2015
- * \date 2016
- */
-/*
- * Copyright (C) 2014-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 HTTP 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_HTTP_HPP
-#define IPXP_PROCESS_HTTP_HPP
+#pragma once
 
 #include <cstdlib>
 #include <cstring>
@@ -42,7 +24,7 @@
 #include <ipfixprobe/flowifc.hpp>
 #include <ipfixprobe/ipfix-elements.hpp>
 #include <ipfixprobe/packet.hpp>
-#include <ipfixprobe/process.hpp>
+#include <ipfixprobe/processPlugin.hpp>
 #include <ipfixprobe/utils.hpp>
 
 namespace ipxp {
@@ -64,7 +46,6 @@ UR_FIELDS(
 	string HTTP_RESPONSE_SERVER,
 	string HTTP_RESPONSE_SET_COOKIE_NAMES)
 
-void copy_str(char* dst, ssize_t size, const char* begin, const char* end);
 void add_str(char* dst, ssize_t size, const char* begin, const char* end, const char* delimiter);
 
 /**
@@ -210,7 +191,7 @@ struct RecordExtHTTP : public RecordExt {
  */
 class HTTPPlugin : public ProcessPlugin {
 public:
-	HTTPPlugin();
+	HTTPPlugin(const std::string& params);
 	~HTTPPlugin();
 	void init(const char* params);
 	void close();
@@ -241,4 +222,3 @@ class HTTPPlugin : public ProcessPlugin {
 };
 
 } // namespace ipxp
-#endif /* IPXP_PROCESS_HTTP_HPP */