ipfixprobe - introduce process DNS plugin

Author: Pavel Siska

src/plugins/process/CMakeLists.txt

@@ -12,6 +12,7 @@ add_subdirectory(wg)
 add_subdirectory(ssdp)
 add_subdirectory(ssaDetector)
 add_subdirectory(mqtt)
+add_subdirectory(dns)
 
 if (ENABLE_PROCESS_EXPERIMENTAL)
 	add_subdirectory(sip)

src/plugins/process/dns/CMakeLists.txt

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

src/plugins/process/dns/README.md

@@ -1,56 +1,41 @@
 /**
- * \file dns.cpp
- * \brief Plugin for parsing DNS 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 DNS traffic.
+ * @author Jiri Havranek <[email protected]>
+ * @author Pavel Siska <[email protected]>
+ * @date 2025
  *
+ * Copyright (c) 2025 CESNET
  *
+ * SPDX-License-Identifier: BSD-3-Clause
  */
 
+#include "dns.hpp"
+
 #include <iostream>
 #include <sstream>
 
 #include <arpa/inet.h>
+#include <ipfixprobe/pluginFactory/pluginManifest.hpp>
+#include <ipfixprobe/pluginFactory/pluginRegistrar.hpp>
 #include <stdio.h>
 #include <stdlib.h>
 
 #ifdef WITH_NEMEA
 #include <unirec/unirec.h>
 #endif
 
-#include "dns.hpp"
-
 namespace ipxp {
 
-int RecordExtDNS::REGISTERED_ID = -1;
-
-__attribute__((constructor)) static void register_this_plugin()
-{
-	static PluginRecord rec = PluginRecord("dns", []() { return new DNSPlugin(); });
-	register_plugin(&rec);
-	RecordExtDNS::REGISTERED_ID = register_extension();
-}
+int RecordExtDNS::REGISTERED_ID = ProcessPluginIDGenerator::instance().generatePluginID();
 
+static const PluginManifest dnsPluginManifest = {
+	.name = "dns",
+	.description = "Dns process plugin for parsing dns traffic.",
+	.pluginVersion = "1.0.0",
+	.apiVersion = "1.0.0",
+	.usage = nullptr,
+};
 // #define DEBUG_DNS
 
 // Print debug message if debugging is allowed.
@@ -79,21 +64,25 @@ __attribute__((constructor)) static void register_this_plugin()
  */
 #define GET_OFFSET(half1, half2) ((((uint8_t) (half1) & 0x3F) << 8) | (uint8_t) (half2))
 
-DNSPlugin::DNSPlugin()
+DNSPlugin::DNSPlugin(const std::string& params)
 	: queries(0)
 	, responses(0)
 	, total(0)
 	, data_begin(nullptr)
 	, data_len(0)
 {
+	init(params.c_str());
 }
 
 DNSPlugin::~DNSPlugin()
 {
 	close();
 }
 
-void DNSPlugin::init(const char* params) {}
+void DNSPlugin::init(const char* params)
+{
+	(void) params;
+}
 
 void DNSPlugin::close() {}
 
@@ -690,4 +679,6 @@ int DNSPlugin::add_ext_dns(const char* data, unsigned int payload_len, bool tcp,
 	return FLOW_FLUSH;
 }
 
+static const PluginRegistrar<DNSPlugin, ProcessPluginFactory> dnsRegistrar(dnsPluginManifest);
+
 } // namespace ipxp

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

@@ -1,34 +1,16 @@
 /**
- * \file dns.hpp
- * \brief Plugin for parsing DNS 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 DNS 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_DNS_HPP
-#define IPXP_PROCESS_DNS_HPP
+#pragma once
 
 #include <cstring>
 #include <sstream>
@@ -38,12 +20,11 @@
 #include "fields.h"
 #endif
 
-#include "dns-utils.hpp"
-
+#include <dns-utils.hpp>
 #include <ipfixprobe/flowifc.hpp>
 #include <ipfixprobe/ipfix-elements.hpp>
 #include <ipfixprobe/packet.hpp>
-#include <ipfixprobe/process.hpp>
+#include <ipfixprobe/processPlugin.hpp>
 
 namespace ipxp {
 
@@ -169,7 +150,7 @@ struct RecordExtDNS : public RecordExt {
  */
 class DNSPlugin : public ProcessPlugin {
 public:
-	DNSPlugin();
+	DNSPlugin(const std::string& params);
 	~DNSPlugin();
 	void init(const char* params);
 	void close();
@@ -205,4 +186,3 @@ class DNSPlugin : public ProcessPlugin {
 };
 
 } // namespace ipxp
-#endif /* IPXP_PROCESS_DNS_HPP */