ipfixprobe: Add usage to all plugins

Pavel Siska · Pavel Siska · commit d1cdf5eaab38 · 2025-03-31T11:58:20.000+02:00
diff --git a/src/plugins/process/basicplus/src/basicplus.cpp b/src/plugins/process/basicplus/src/basicplus.cpp
@@ -24,7 +24,13 @@ static const PluginManifest basicplusPluginManifest = {
 	.description = "Basicplus process plugin for parsing basicplus traffic.",
 	.pluginVersion = "1.0.0",
 	.apiVersion = "1.0.0",
-	.usage = nullptr,
+	.usage =
+		[]() {
+			OptionsParser parser(
+				"basicplus",
+				"Extend basic fields with TTL, TCP window, options, MSS and SYN size");
+			parser.usage(std::cout);
+		},
 };
 
 BASICPLUSPlugin::BASICPLUSPlugin(const std::string& params, int pluginID)
diff --git a/src/plugins/process/bstats/src/bstats.cpp b/src/plugins/process/bstats/src/bstats.cpp
@@ -24,7 +24,11 @@ static const PluginManifest bstatsPluginManifest = {
 	.description = "Bstats process plugin for computing packet bursts stats.",
 	.pluginVersion = "1.0.0",
 	.apiVersion = "1.0.0",
-	.usage = nullptr,
+	.usage =
+		[]() {
+			OptionsParser parser("bstats", "Compute packet bursts stats");
+			parser.usage(std::cout);
+		},
 };
 
 const struct timeval BSTATSPlugin::min_packet_in_burst
diff --git a/src/plugins/process/dns/src/dns.cpp b/src/plugins/process/dns/src/dns.cpp
@@ -32,7 +32,11 @@ static const PluginManifest dnsPluginManifest = {
 	.description = "Dns process plugin for parsing dns traffic.",
 	.pluginVersion = "1.0.0",
 	.apiVersion = "1.0.0",
-	.usage = nullptr,
+	.usage =
+		[]() {
+			OptionsParser parser("dns", "Parse DNS traffic");
+			parser.usage(std::cout);
+		},
 };
 // #define DEBUG_DNS
 
diff --git a/src/plugins/process/flowHash/src/flow_hash.cpp b/src/plugins/process/flowHash/src/flow_hash.cpp
@@ -24,7 +24,11 @@ static const PluginManifest flowhashPluginManifest = {
 	.description = "flowhash process plugin for parsing flowhash value.",
 	.pluginVersion = "1.0.0",
 	.apiVersion = "1.0.0",
-	.usage = nullptr,
+	.usage =
+		[]() {
+			OptionsParser parser("flowhash", "Export flow hash as flow id");
+			parser.usage(std::cout);
+		},
 };
 
 FLOW_HASHPlugin::FLOW_HASHPlugin(const std::string& params, int pluginID)
diff --git a/src/plugins/process/http/src/http.cpp b/src/plugins/process/http/src/http.cpp
@@ -10,9 +10,8 @@
  * SPDX-License-Identifier: BSD-3-Clause
  */
 
-#include "http.hpp"
-
 #include "common.hpp"
+#include "http.hpp"
 
 #include <cstdlib>
 #include <cstring>
@@ -32,7 +31,11 @@ static const PluginManifest httpPluginManifest = {
 	.description = "http process plugin for parsing http traffic.",
 	.pluginVersion = "1.0.0",
 	.apiVersion = "1.0.0",
-	.usage = nullptr,
+	.usage =
+		[]() {
+			OptionsParser parser("http", "Parse HTTP traffic");
+			parser.usage(std::cout);
+		},
 };
 
 // #define DEBUG_HTTP
diff --git a/src/plugins/process/icmp/src/icmp.cpp b/src/plugins/process/icmp/src/icmp.cpp
@@ -24,7 +24,11 @@ static const PluginManifest icmpPluginManifest = {
 	.description = "ICMP process plugin for parsing icmp traffic.",
 	.pluginVersion = "1.0.0",
 	.apiVersion = "1.0.0",
-	.usage = nullptr,
+	.usage =
+		[]() {
+			OptionsParser parser("icmp", "Parse ICMP traffic");
+			parser.usage(std::cout);
+		},
 };
 
 ICMPPlugin::ICMPPlugin(const std::string& params, int pluginID)
diff --git a/src/plugins/process/idpContent/src/idpcontent.cpp b/src/plugins/process/idpContent/src/idpcontent.cpp
@@ -24,7 +24,11 @@ static const PluginManifest idpcontentPluginManifest = {
 	.description = "Idpcontent process plugin for parsing idpcontent traffic.",
 	.pluginVersion = "1.0.0",
 	.apiVersion = "1.0.0",
-	.usage = nullptr,
+	.usage =
+		[]() {
+			OptionsParser parser("idpcontent", "Parse first bytes of flow payload");
+			parser.usage(std::cout);
+		},
 };
 
 #define MIN(a, b) (((a) < (b)) ? (a) : (b))
diff --git a/src/plugins/process/netbios/src/netbios.cpp b/src/plugins/process/netbios/src/netbios.cpp
@@ -28,7 +28,11 @@ static const PluginManifest netbiosPluginManifest = {
 	.description = "Netbios process plugin for parsing netbios traffic.",
 	.pluginVersion = "1.0.0",
 	.apiVersion = "1.0.0",
-	.usage = nullptr,
+	.usage =
+		[]() {
+			OptionsParser parser("netbios", "Parse netbios traffic");
+			parser.usage(std::cout);
+		},
 };
 NETBIOSPlugin::NETBIOSPlugin(const std::string& params, int pluginID)
 	: ProcessPlugin(pluginID)
diff --git a/src/plugins/process/nettisa/src/nettisa.cpp b/src/plugins/process/nettisa/src/nettisa.cpp
@@ -25,7 +25,11 @@ static const PluginManifest nettisaPluginManifest = {
 	.description = "Nettisa process plugin for parsing Nettisa flow.",
 	.pluginVersion = "1.0.0",
 	.apiVersion = "1.0.0",
-	.usage = nullptr,
+	.usage =
+		[]() {
+			OptionsParser parser("nettisa", "Parse NetTiSA flow");
+			parser.usage(std::cout);
+		},
 };
 
 NETTISAPlugin::NETTISAPlugin(const std::string& params, int pluginID)
diff --git a/src/plugins/process/osquery/src/osquery.cpp b/src/plugins/process/osquery/src/osquery.cpp
@@ -30,7 +30,13 @@ static const PluginManifest osqueryPluginManifest = {
 	.description = "Osquery process plugin for parsing osquery traffic.",
 	.pluginVersion = "1.0.0",
 	.apiVersion = "1.0.0",
-	.usage = nullptr,
+	.usage =
+		[]() {
+			OptionsParser parser(
+				"osquery",
+				"Collect information about locally outbound flows from OS");
+			parser.usage(std::cout);
+		},
 };
 
 OSQUERYPlugin::OSQUERYPlugin(const std::string& params, int pluginID)
diff --git a/src/plugins/process/ovpn/src/ovpn.cpp b/src/plugins/process/ovpn/src/ovpn.cpp
@@ -54,7 +54,11 @@ static const PluginManifest ovpnPluginManifest = {
 	.description = "Ovpn process plugin for parsing ovpn traffic.",
 	.pluginVersion = "1.0.0",
 	.apiVersion = "1.0.0",
-	.usage = nullptr,
+	.usage =
+		[]() {
+			OptionsParser parser("ovpn", "OpenVPN detector plugin");
+			parser.usage(std::cout);
+		},
 };
 
 OVPNPlugin::OVPNPlugin(const std::string& params, int pluginID)
diff --git a/src/plugins/process/passiveDns/src/passivedns.cpp b/src/plugins/process/passiveDns/src/passivedns.cpp
@@ -38,7 +38,11 @@ static const PluginManifest passivednsPluginManifest = {
 	.description = "Passivedns process plugin for parsing DNS A and AAAA records.",
 	.pluginVersion = "1.0.0",
 	.apiVersion = "1.0.0",
-	.usage = nullptr,
+	.usage =
+		[]() {
+			OptionsParser parser("passivedns", "Parse A, AAAA and PTR records from DNS traffic");
+			parser.usage(std::cout);
+		},
 };
 
 // #define DEBUG_PASSIVEDNS
diff --git a/src/plugins/process/quic/src/quic.cpp b/src/plugins/process/quic/src/quic.cpp
@@ -27,7 +27,11 @@ static const PluginManifest quicPluginManifest = {
 	.description = "Quic process plugin for parsing quic traffic.",
 	.pluginVersion = "1.0.0",
 	.apiVersion = "1.0.0",
-	.usage = nullptr,
+	.usage =
+		[]() {
+			OptionsParser parser("quic", "Parse QUIC traffic");
+			parser.usage(std::cout);
+		},
 };
 
 QUICPlugin::QUICPlugin(const std::string& params, int pluginID)
diff --git a/src/plugins/process/smtp/src/smtp.cpp b/src/plugins/process/smtp/src/smtp.cpp
@@ -10,9 +10,8 @@
  * SPDX-License-Identifier: BSD-3-Clause
  */
 
-#include "smtp.hpp"
-
 #include "common.hpp"
+#include "smtp.hpp"
 
 #include <cstring>
 #include <iostream>
@@ -28,7 +27,11 @@ static const PluginManifest smtpPluginManifest = {
 	.description = "Smtp process plugin for parsing smtp traffic.",
 	.pluginVersion = "1.0.0",
 	.apiVersion = "1.0.0",
-	.usage = nullptr,
+	.usage =
+		[]() {
+			OptionsParser parser("smtp", "Parse SMTP traffic");
+			parser.usage(std::cout);
+		},
 };
 
 SMTPPlugin::SMTPPlugin(const std::string& params, int pluginID)
diff --git a/src/plugins/process/ssaDetector/src/ssadetector.cpp b/src/plugins/process/ssaDetector/src/ssadetector.cpp
@@ -25,7 +25,13 @@ static const PluginManifest ssadetectorPluginManifest = {
 	.description = "Ssadetector process plugin for parsing vpn_automaton traffic.",
 	.pluginVersion = "1.0.0",
 	.apiVersion = "1.0.0",
-	.usage = nullptr,
+	.usage =
+		[]() {
+			OptionsParser parser(
+				"ssadetector",
+				"Check traffic for SYN-SYNACK-ACK sequence to find possible network tunnels.");
+			parser.usage(std::cout);
+		},
 };
 
 SSADetectorPlugin::SSADetectorPlugin(const std::string& params, int pluginID)
diff --git a/src/plugins/process/ssaDetector/src/ssadetector.hpp b/src/plugins/process/ssaDetector/src/ssadetector.hpp
@@ -148,10 +148,10 @@ class SSADetectorPlugin : public ProcessPlugin {
 	OptionsParser* get_parser() const
 	{
 		return new OptionsParser(
-			"SSADetector",
+			"ssadetector",
 			"Check traffic for SYN-SYNACK-ACK sequence to find possible network tunnels.");
 	}
-	std::string get_name() const { return "SSADetector"; }
+	std::string get_name() const { return "ssadetector"; }
 	RecordExt* get_ext() const { return new RecordExtSSADetector(m_pluginID); }
 	ProcessPlugin* copy();
 
diff --git a/src/plugins/process/ssdp/src/ssdp.cpp b/src/plugins/process/ssdp/src/ssdp.cpp
@@ -24,7 +24,11 @@ static const PluginManifest ssdpPluginManifest = {
 	.description = "Ssdp process plugin for parsing ssdp traffic.",
 	.pluginVersion = "1.0.0",
 	.apiVersion = "1.0.0",
-	.usage = nullptr,
+	.usage =
+		[]() {
+			OptionsParser parser("ssdp", "Parse SSDP traffic");
+			parser.usage(std::cout);
+		},
 };
 
 // #define DEBUG_SSDP
diff --git a/src/plugins/process/tls/src/tls.cpp b/src/plugins/process/tls/src/tls.cpp
@@ -11,10 +11,9 @@
  *
  * SPDX-License-Identifier: BSD-3-Clause
  */
-#include "tls.hpp"
-
 #include "md5.hpp"
 #include "sha256.hpp"
+#include "tls.hpp"
 
 #include <algorithm>
 #include <cctype>
@@ -33,7 +32,11 @@ static const PluginManifest tlsPluginManifest = {
 	.description = "Tls process plugin for parsing tls traffic.",
 	.pluginVersion = "1.0.0",
 	.apiVersion = "1.0.0",
-	.usage = nullptr,
+	.usage =
+		[]() {
+			OptionsParser parser("tls", "Parse TLS traffic");
+			parser.usage(std::cout);
+		},
 };
 
 // Print debug message if debugging is allowed.
diff --git a/src/plugins/process/vlan/src/vlan.cpp b/src/plugins/process/vlan/src/vlan.cpp
@@ -24,7 +24,11 @@ static const PluginManifest vlanPluginManifest = {
 	.description = "Vlan process plugin for parsing vlan traffic.",
 	.pluginVersion = "1.0.0",
 	.apiVersion = "1.0.0",
-	.usage = nullptr,
+	.usage =
+		[]() {
+			OptionsParser parser("vlan", "Parse VLAN traffic");
+			parser.usage(std::cout);
+		},
 };
 
 VLANPlugin::VLANPlugin(const std::string& params, int pluginID)
diff --git a/src/plugins/process/wg/src/wg.cpp b/src/plugins/process/wg/src/wg.cpp
@@ -26,7 +26,11 @@ static const PluginManifest wgPluginManifest = {
 	.description = "Wg process plugin for parsing wg traffic.",
 	.pluginVersion = "1.0.0",
 	.apiVersion = "1.0.0",
-	.usage = nullptr,
+	.usage =
+		[]() {
+			OptionsParser parser("wg", "Parse WireGuard traffic");
+			parser.usage(std::cout);
+		},
 };
 
 WGPlugin::WGPlugin(const std::string& params, int pluginID)
