ipfixprobe - introduce input PCAP plugin

Author: SiskaPavel

src/plugins/input/CMakeLists.txt

@@ -1 +1,2 @@
 add_subdirectory(parser)
+add_subdirectory(pcap)

src/plugins/input/pcap/CMakeLists.txt

@@ -0,0 +1,25 @@
+project(ipfixprobe-input-pcap VERSION 1.0.0 DESCRIPTION "ipfixprobe-input-pcap plugin")
+
+add_library(ipfixprobe-input-pcap MODULE
+    src/pcap.cpp
+    src/pcap.hpp
+)
+
+set_target_properties(ipfixprobe-input-pcap PROPERTIES
+    CXX_VISIBILITY_PRESET hidden
+    VISIBILITY_INLINES_HIDDEN YES
+)
+target_include_directories(ipfixprobe-input-pcap PRIVATE 
+    ${PCAP_INCLUDE_DIRS}
+    ${CMAKE_SOURCE_DIR}/include/
+    ${CMAKE_SOURCE_DIR}/src/plugins/input/parser
+)
+    
+target_link_libraries(ipfixprobe-input-pcap PRIVATE 
+    ipfixprobe-parser
+    ${PCAP_LIBRARIES}
+)
+
+install(TARGETS ipfixprobe-input-pcap
+    LIBRARY DESTINATION "${INSTALL_DIR_LIB}/ipfixprobe/input/"
+)

src/plugins/input/pcap/README.md

@@ -1,40 +1,24 @@
 /**
- * \file pcap.cpp
- * \brief Pcap reader based on libpcap
- * \author Jiri Havranek <[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 Pcap reader based on libpcap
+ * @author Jiri Havranek <[email protected]>
+ * @date 2025
  *
+ * Copyright (c) 2025 CESNET
  *
+ * SPDX-License-Identifier: BSD-3-Clause
  */
 
-#include "pcap.hpp"
-
 #include "parser.hpp"
+#include "pcap.hpp"
 
 #include <cstdio>
 #include <cstring>
 #include <iomanip>
 #include <iostream>
 
+#include <ipfixprobe/pluginFactory/pluginManifest.hpp>
+#include <ipfixprobe/pluginFactory/pluginRegistrar.hpp>
 #include <pcap/pcap.h>
 
 namespace ipxp {
@@ -47,11 +31,15 @@ struct UserData {
 	ParserStats& stats;
 };
 
-__attribute__((constructor)) static void register_this_plugin()
-{
-	static PluginRecord rec = PluginRecord("pcap", []() { return new PcapReader(); });
-	register_plugin(&rec);
-}
+static const PluginManifest pcapPluginManifest
+	= {.name = "pcap",
+	   .description = "Pcap input plugin for reading packets from network interface or pcap file.",
+	   .pluginVersion = "1.0.0",
+	   .apiVersion = "1.0.0",
+	   .usage = []() {
+		   PcapOptParser parser;
+		   parser.usage(std::cout);
+	   }};
 
 /**
  * \brief Parsing callback function for pcap_dispatch() call. Parse packets up to transport layer.
@@ -79,13 +67,14 @@ void packet_handler(u_char* arg, const struct pcap_pkthdr* h, const u_char* data
 #endif
 }
 
-PcapReader::PcapReader()
+PcapReader::PcapReader(const std::string& params)
 	: m_handle(nullptr)
 	, m_snaplen(-1)
 	, m_datalink(0)
 	, m_live(false)
 	, m_netmask(PCAP_NETMASK_UNKNOWN)
 {
+	init(params.c_str());
 }
 
 PcapReader::~PcapReader()
@@ -301,4 +290,6 @@ InputPlugin::Result PcapReader::get(PacketBlock& packets)
 	return Result::NOT_PARSED;
 }
 
+static const PluginRegistrar<PcapReader, InputPluginFactory> pcapRegistrar(pcapPluginManifest);
+
 } // namespace ipxp

src/plugins/input/pcap.cpp src/plugins/input/pcap/src/pcap.cppsrc/plugins/input/pcap.cpp renamed to src/plugins/input/pcap/src/pcap.cpp

@@ -1,35 +1,18 @@
 /**
- * \file pcap.hpp
- * \brief Pcap reader based on libpcap
- * \author Jiri Havranek <[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 Pcap reader based on libpcap
+ * @author Jiri Havranek <[email protected]>
+ * @author Pavel Siska <[email protected]>
+ * @date 2025
  *
+ * Copyright (c) 2025 CESNET
  *
+ * SPDX-License-Identifier: BSD-3-Clause
  */
 
-#ifndef IPXP_INPUT_PCAP_HPP
-#define IPXP_INPUT_PCAP_HPP
+#pragma once
 
-#include <ipfixprobe/input.hpp>
+#include <ipfixprobe/inputPlugin.hpp>
 #include <ipfixprobe/options.hpp>
 #include <ipfixprobe/packet.hpp>
 #include <ipfixprobe/utils.hpp>
@@ -132,7 +115,7 @@ class PcapOptParser : public OptionsParser {
  */
 class PcapReader : public InputPlugin {
 public:
-	PcapReader();
+	PcapReader(const std::string& params);
 	~PcapReader();
 
 	void init(const char* params);
@@ -159,4 +142,3 @@ class PcapReader : public InputPlugin {
 void packet_handler(u_char* arg, const struct pcap_pkthdr* h, const u_char* data);
 
 } // namespace ipxp
-#endif /* IPXP_INPUT_PCAP_HPP */