Process plugins - Introduce MQTT process plugins

Author: Zainullin Damir

src/plugins/process/mqtt/CMakeLists.txt

@@ -3,15 +3,24 @@ project(ipfixprobe-process-mqtt VERSION 1.0.0 DESCRIPTION "ipfixprobe-process-mq
 add_library(ipfixprobe-process-mqtt MODULE
 	src/mqtt.cpp
 	src/mqtt.hpp
+	src/mqttContext.hpp
+	src/mqttFields.hpp
+	src/mqttHeaderType.hpp
+	src/mqttTypeFlag.hpp
+	src/variableLengthInt.hpp
 )
 
 set_target_properties(ipfixprobe-process-mqtt PROPERTIES
 	CXX_VISIBILITY_PRESET hidden
 	VISIBILITY_INLINES_HIDDEN YES
 )
 
-target_include_directories(ipfixprobe-process-mqtt PRIVATE
+target_include_directories(ipfixprobe-process-mqtt PRIVATE 
 	${CMAKE_SOURCE_DIR}/include/
+	${CMAKE_SOURCE_DIR}/include/ipfixprobe/processPlugin
+	${CMAKE_SOURCE_DIR}/include/ipfixprobe/pluginFactory
+	${CMAKE_SOURCE_DIR}/src/plugins/process/common
+	${adaptmon_SOURCE_DIR}/lib/include/public/
 )
 
 if(ENABLE_NEMEA)

src/plugins/process/mqtt/README.md

@@ -0,0 +1,48 @@
+# MQTT Plugin
+
+The **MQTT Plugin** extends flow records with MQTT (Message Queuing Telemetry Transport) message information.
+
+## Features
+
+- Extracts and exports MQTT fields if flow contains MQTT information.
+- Only MQTT v3.1.1 and v5.0 are supported.
+- Flow is finished when _disconect_ message is received.
+
+## Parameters
+
+| Long name | Short name   | Type  | Default | Description                                             |
+| --------- | ------------ | ----- | ------- | ------------------------------------------------------- |
+| `tc`      | `topiccount` | `int` | 10      | Maximal count of topics from _publish_ messages to save |
+
+## Output Fields
+
+| Field Name                                                                 | Data Type  | Description                                                                               |
+| -------------------------------------------------------------------------- | ---------- | ----------------------------------------------------------------------------------------- |
+| `MQQT_TYPE_CUMULATIVE`                                                     | `uint16_t` | Bitfield of messages that were detected during the communication. Each value takes 1 bit. |
+| DISCONNECT \| PINGRESP \| PINGREQ \| UNSUBACK \| UNSUBSCRIBE \|            |
+| SUBACK \| SUBSCRIBE \| PUBCOMP \| PUBREL \| PUBREC \| PUBACK \| PUBLISH \| |
+| CONNACK \| CONNECT \| session present flag from _connection_ message\|     |
+| `MQTT_VERSION`                                                             | `uint8_t`  | Identifies the MQTT version being used.                                                   |
+| `MQTT_CONNECTION_FLAGS`                                                    | `uint8_t`  | Flags of _connection_ message.                                                            |
+| `MQTT_KEEP_ALIVE`                                                          | `uint16_t` | MQTT connection keep alive                                                                |
+| `MQTT_CONNECTION_RETURN_CODE`                                              | `uint8_t`  | Return code value from _connack_ message.                                                 |
+| `MQTT_PUBLISH_FLAGS`                                                       | `uint8_t`  | Cumulative of _publish_ message flags.                                                    |
+| `MQTT_TOPICS`                                                              | `string`   | Concatenation of **topiccount** topics from _publish_ messages.                           |
+
+## Usage
+
+### YAML Configuration
+
+Add the plugin to your ipfixprobe YAML configuration:
+
+```yaml
+process_plugins:
+  - mqtt
+```
+
+### CLI Usage
+
+You can also enable the plugin directly from the command line:
+
+`ipfixprobe -p mqtt ...`
+`ipfixprobe -p "mqtt;tc=<topic_count>" ...`