Scanning Engine v2 - Module - MQTT¶
Overview¶
The Message Queuing Telemetry Transport (MQTT) is a lightweight, publish-subscribe, machine to machine network protocol for message queue/message queuing service. It is designed for connections with remote locations that have devices with resource constraints or limited network bandwidth, such as in the Internet of Things (IoT).
Upon connection to an MQTT service, this module attempts to dump the service's info. Also gathers any messages from public topics.
Targeting¶
This module targets TCP ports by IP address or hostname.
Schemas¶
The schema for the body object of all results generated with .task.module_name equal to mqtt can be found here. The schema for results is available both in standalone and bundled form.
Examples¶
These are examples of the .body object for results with .task.module_name equal to mqtt.
Live Host¶
This example was generated with a live host on the internet.
{
"bytes_captured": 38092,
"num_events": 131,
"num_topics": 53,
"topics": [
"$SYS/broker/bytes/received",
"$SYS/broker/bytes/sent",
"$SYS/broker/clients/active",
"$SYS/broker/clients/connected",
"$SYS/broker/clients/disconnected",
"$SYS/broker/clients/expired",
"$SYS/broker/clients/inactive",
"$SYS/broker/clients/maximum",
"$SYS/broker/clients/total",
"$SYS/broker/load/bytes/received/15min",
"$SYS/broker/load/bytes/received/1min",
"$SYS/broker/load/bytes/received/5min",
"$SYS/broker/load/bytes/sent/15min",
"$SYS/broker/load/bytes/sent/1min",
"$SYS/broker/load/bytes/sent/5min",
"$SYS/broker/load/connections/15min",
"$SYS/broker/load/connections/1min",
"$SYS/broker/load/connections/5min",
"$SYS/broker/load/messages/received/15min",
"$SYS/broker/load/messages/received/1min",
"$SYS/broker/load/messages/received/5min",
"$SYS/broker/load/messages/sent/15min",
"$SYS/broker/load/messages/sent/1min",
"$SYS/broker/load/messages/sent/5min",
"$SYS/broker/load/publish/dropped/15min",
"$SYS/broker/load/publish/dropped/1min",
"$SYS/broker/load/publish/dropped/5min",
"$SYS/broker/load/publish/received/15min",
"$SYS/broker/load/publish/received/1min",
"$SYS/broker/load/publish/received/5min",
"$SYS/broker/load/publish/sent/15min",
"$SYS/broker/load/publish/sent/1min",
"$SYS/broker/load/publish/sent/5min",
"$SYS/broker/load/sockets/15min",
"$SYS/broker/load/sockets/1min",
"$SYS/broker/load/sockets/5min",
"$SYS/broker/messages/received",
"$SYS/broker/messages/sent",
"$SYS/broker/messages/stored",
"$SYS/broker/publish/bytes/received",
"$SYS/broker/publish/bytes/sent",
"$SYS/broker/publish/messages/dropped",
"$SYS/broker/publish/messages/received",
"$SYS/broker/publish/messages/sent",
"$SYS/broker/retained messages/count",
"$SYS/broker/store/messages/bytes",
"$SYS/broker/store/messages/count",
"$SYS/broker/subscriptions/count",
"$SYS/broker/uptime",
"$SYS/broker/version",
"sys/001/AP/EG310G-E/CARL61D00377A/inform",
"sys/001/alarm_del",
"sys/FFFF/master"
],
"messages": [
{
"$SYS/broker/version": "mosquitto version 1.5.9"
},
{
"$SYS/broker/uptime": "8670552 seconds"
},
{
"$SYS/broker/clients/total": "18"
},
{
"$SYS/broker/clients/inactive": "14"
},
{
"$SYS/broker/clients/disconnected": "14"
},
{
"$SYS/broker/clients/active": "4"
},
{
"$SYS/broker/clients/connected": "4"
},
{
"$SYS/broker/clients/expired": "0"
},
{
"$SYS/broker/clients/maximum": "19"
},
{
"$SYS/broker/load/messages/received/1min": "37.82"
},
{
"$SYS/broker/load/messages/received/5min": "38.04"
},
{
"$SYS/broker/load/messages/received/15min": "37.92"
},
{
"$SYS/broker/load/messages/sent/1min": "38.74"
},
{
"$SYS/broker/load/messages/sent/5min": "45.39"
},
{
"$SYS/broker/load/messages/sent/15min": "42.39"
},
{
"$SYS/broker/load/publish/dropped/1min": "0.00"
},
{
"$SYS/broker/load/publish/dropped/5min": "0.00"
},
{
"$SYS/broker/load/publish/dropped/15min": "0.00"
},
{
"$SYS/broker/load/publish/received/1min": "29.17"
},
{
"$SYS/broker/load/publish/received/5min": "29.69"
},
{
"$SYS/broker/load/publish/received/15min": "29.74"
},
{
"$SYS/broker/load/publish/sent/1min": "30.09"
},
{
"$SYS/broker/load/publish/sent/5min": "37.03"
},
{
"$SYS/broker/load/publish/sent/15min": "34.20"
},
{
"$SYS/broker/load/bytes/received/1min": "10949.97"
},
{
"$SYS/broker/load/bytes/received/5min": "10404.36"
},
{
"$SYS/broker/load/bytes/received/15min": "10318.25"
},
{
"$SYS/broker/load/bytes/sent/1min": "11019.88"
},
{
"$SYS/broker/load/bytes/sent/5min": "10975.89"
},
{
"$SYS/broker/load/bytes/sent/15min": "10669.65"
},
{
"$SYS/broker/load/sockets/1min": "0.06"
},
{
"$SYS/broker/load/sockets/5min": "0.20"
},
{
"$SYS/broker/load/sockets/15min": "0.07"
},
{
"$SYS/broker/load/connections/1min": "0.06"
},
{
"$SYS/broker/load/connections/5min": "0.20"
},
{
"$SYS/broker/load/connections/15min": "0.07"
},
{
"$SYS/broker/messages/stored": "93"
},
{
"$SYS/broker/messages/received": "5458740"
},
{
"$SYS/broker/messages/sent": "5445193"
},
{
"$SYS/broker/store/messages/count": "93"
},
{
"$SYS/broker/store/messages/bytes": "501"
},
{
"$SYS/broker/subscriptions/count": "45"
},
{
"$SYS/broker/retained messages/count": "50"
},
{
"$SYS/broker/publish/messages/dropped": "0"
},
{
"$SYS/broker/publish/messages/received": "4301461"
},
{
"$SYS/broker/publish/messages/sent": "4288169"
},
{
"$SYS/broker/publish/bytes/received": "1387999007"
},
{
"$SYS/broker/publish/bytes/sent": "1388187066"
},
{
"$SYS/broker/bytes/received": "1484794339"
},
{
"$SYS/broker/bytes/sent": "1484816375"
},
{
"sys/FFFF/master": "{ 'sn': 'CARL61D00377A', 'devModel': 'EG310G-E', 'mac': '54:16:51:47:F1:37', 'tipcInst': 1196499365, 'software': 'ReyeeOS 1.95.1815;EG_3.0(1)B11P95,Release(09181516)', 'protoVer': 3 }"
},
{
"sys/FFFF/master": "{ 'sn': 'CARL61D00377A', 'devModel': 'EG310G-E', 'mac': '54:16:51:47:F1:37', 'tipcInst': 1196499365, 'software': 'ReyeeOS 1.95.1815;EG_3.0(1)B11P95,Release(09181516)', 'protoVer': 3 }"
},
{
"sys/001/alarm_del": "{ 'list': [ 180 ] }"
},
{
"sys/FFFF/master": "{ 'sn': 'CARL61D00377A', 'devModel': 'EG310G-E', 'mac': '54:16:51:47:F1:37', 'tipcInst': 1196499365, 'software': 'ReyeeOS 1.95.1815;EG_3.0(1)B11P95,Release(09181516)', 'protoVer': 3 }"
},
{
"$SYS/broker/uptime": "8670563 seconds"
},
{
"$SYS/broker/clients/total": "19"
},
{
"$SYS/broker/clients/active": "5"
},
{
"$SYS/broker/clients/connected": "5"
},
{
"$SYS/broker/load/messages/received/1min": "40.63"
},
{
"$SYS/broker/load/messages/sent/1min": "90.72"
},
{
"$SYS/broker/load/publish/received/1min": "29.77"
},
{
"$SYS/broker/load/publish/sent/1min": "79.87"
},
{
"$SYS/broker/load/bytes/received/1min": "9964.56"
},
{
"$SYS/broker/load/bytes/sent/1min": "12497.94"
},
{
"$SYS/broker/load/sockets/1min": "0.92"
},
{
"$SYS/broker/load/connections/1min": "0.92"
},
{
"$SYS/broker/load/messages/received/5min": "38.65"
},
{
"$SYS/broker/load/messages/sent/5min": "56.33"
},
{
"$SYS/broker/load/publish/received/5min": "29.80"
},
{
"$SYS/broker/load/publish/sent/5min": "47.48"
},
{
"$SYS/broker/load/bytes/received/5min": "10212.21"
},
{
"$SYS/broker/load/bytes/sent/5min": "11295.15"
},
{
"$SYS/broker/load/sockets/5min": "0.27"
},
{
"$SYS/broker/load/connections/5min": "0.27"
},
{
"$SYS/broker/load/messages/received/15min": "38.14"
},
{
"$SYS/broker/load/messages/sent/15min": "46.11"
},
{
"$SYS/broker/load/publish/received/15min": "29.78"
},
{
"$SYS/broker/load/publish/sent/15min": "37.76"
},
{
"$SYS/broker/load/bytes/received/15min": "10254.46"
},
{
"$SYS/broker/load/bytes/sent/15min": "10781.10"
},
{
"$SYS/broker/load/sockets/15min": "0.12"
},
{
"$SYS/broker/load/connections/15min": "0.12"
},
{
"$SYS/broker/store/messages/bytes": "500"
},
{
"$SYS/broker/subscriptions/count": "47"
},
{
"$SYS/broker/messages/received": "5458750"
},
{
"$SYS/broker/messages/sent": "5445257"
},
{
"$SYS/broker/publish/messages/received": "4301467"
},
{
"$SYS/broker/publish/messages/sent": "4288229"
},
{
"$SYS/broker/bytes/received": "1484795268"
},
{
"$SYS/broker/bytes/sent": "1484820013"
},
{
"$SYS/broker/publish/bytes/received": "1387999777"
},
{
"$SYS/broker/publish/bytes/sent": "1388188677"
},
{
"sys/FFFF/master": "{ 'sn': 'CARL61D00377A', 'devModel': 'EG310G-E', 'mac': '54:16:51:47:F1:37', 'tipcInst': 1196499365, 'software': 'ReyeeOS 1.95.1815;EG_3.0(1)B11P95,Release(09181516)', 'protoVer': 3 }"
},
{
"sys/FFFF/master": "{ 'sn': 'CARL61D00377A', 'devModel': 'EG310G-E', 'mac': '54:16:51:47:F1:37', 'tipcInst': 1196499365, 'software': 'ReyeeOS 1.95.1815;EG_3.0(1)B11P95,Release(09181516)', 'protoVer': 3 }"
},
{
"sys/001/alarm_del": "{ 'list': [ 180 ] }"
},
{
"sys/FFFF/master": "{ 'sn': 'CARL61D00377A', 'devModel': 'EG310G-E', 'mac': '54:16:51:47:F1:37', 'tipcInst': 1196499365, 'software': 'ReyeeOS 1.95.1815;EG_3.0(1)B11P95,Release(09181516)', 'protoVer': 3 }"
},
{
"sys/FFFF/master": "{ 'sn': 'CARL61D00377A', 'devModel': 'EG310G-E', 'mac': '54:16:51:47:F1:37', 'tipcInst': 1196499365, 'software': 'ReyeeOS 1.95.1815;EG_3.0(1)B11P95,Release(09181516)', 'protoVer': 3 }"
},
{
"sys/001/AP/EG310G-E/CARL61D00377A/inform": "{ 'type': 'inform', 'typeid': 2, 'code': 0, 'msg': { 'product': 'EGW', 'deviceType': 'EG310G-E', 'devModel': 'EG310G-E', 'deviceSn': 'CARL61D00377A', 'ip': '10.11.5.17', 'tI': 1196499365, 'mac': '54:16:51:47:F1:37', 'periodInformInterval': 30, 'informPeriod': 30, 'hardware': '1.00', 'software': 'ReyeeOS 1.95.1815;EG_3.0(1)B11P95,Release(09181516)', 'os': 'OW', 'networkId': 'dev_54:16:51:47:F1:37_1653495561', 'networkName': '880000272869', 'groupId': '0', 'groupName': 'default', 'parentGroupId': '', 'forwardMode': 'ROUTER', 'relayMode': 'none', 'hostName': 'Ruijie', 'staNum': 0, 'startTime': '2025-06-02 10:36:45', 'currentTime': '2025-09-10 19:06:48', 'configId': { 'rootPath': '\\/etc\\/rg_config\\/global\\/', 'configversion': [ { 'networkId': 'dev_54:16:51:47:F1:37_1653495561', 'configId': '0', 'currentTime': '1653495143', 'groupId': '0', 'configTime': '1653495143', 'module': 'tmngt', 'subConfigId': '1653495581_CARL61D00377A', 'moduleId': '13' }, { 'networkId': 'dev_54:16:51:47:F1:37_1653495561', 'configId': '0', 'currentTime': '0', 'groupId': '0', 'configTime': '0', 'module': 'timeReboot', 'subConfigId': '1653495581_CARL61D00377A', 'moduleId': '12' }, { 'networkId': 'dev_54:16:51:47:F1:37_1653495561', 'configId': '0', 'currentTime': '0', 'groupId': '0', 'configTime': '0', 'module': 'devLed', 'subConfigId': '1653495581_CARL61D00377A', 'moduleId': '15' }, { 'networkId': 'dev_54:16:51:47:F1:37_1653495561', 'configId': '1653495561', 'currentTime': '1653495561', 'groupId': '0', 'configTime': '1653495561', 'module': 'network_group', 'subConfigId': '1653495561_CARL61D00377A', 'moduleId': '6' }, { 'networkId': 'dev_54:16:51:47:F1:37_1653495561', 'configId': '0', 'currentTime': '0', 'groupId': '0', 'configTime': '0', 'module': 'wireless', 'subConfigId': '1653495569_CARL61D00377A', 'moduleId': '1' }, { 'networkId': 'dev_54:16:51:47:F1:37_1653495561', 'configId': '0', 'currentTime': '0', 'groupId': '0', 'configTime': '0', 'module': 'timezone', 'subConfigId': '1653495581_CARL61D00377A', 'moduleId': '2' }, { 'networkId': 'dev_54:16:51:47:F1:37_1653495561', 'configId': '0', 'currentTime': '0', 'groupId': '0', 'configTime': '0', 'module': 'wirelan', 'subConfigId': '1653495581_CARL61D00377A', 'moduleId': '11' }, { 'networkId': 'dev_54:16:51:47:F1:37_1653495561', 'configId': '1653495562', 'currentTime': '1653495562', 'groupId': '0', 'configTime': '1653495562', 'module': 'eweb_password', 'subConfigId': '1653495562_CARL61D00377A', 'moduleId': '7' }, { 'networkId': 'dev_54:16:51:47:F1:37_1653495561', 'configId': '0', 'currentTime': '0', 'groupId': '0', 'configTime': '0', 'module': 'ntpserver', 'subConfigId': '1653495581_CARL61D00377A', 'moduleId': '3' }, { 'networkId': 'dev_54:16:51:47:F1:37_1653495561', 'configId': '0', 'currentTime': '0', 'groupId': '0', 'configTime': '0', 'module': 'wirelessMacFilter', 'subConfigId': '1653495581_CARL61D00377A', 'moduleId': '10' } ] } } }"
},
{
"$SYS/broker/uptime": "8670574 seconds"
},
{
"$SYS/broker/load/messages/received/1min": "40.22"
},
{
"$SYS/broker/load/messages/sent/1min": "122.12"
},
{
"$SYS/broker/load/publish/received/1min": "30.26"
},
{
"$SYS/broker/load/publish/sent/1min": "112.17"
},
{
"$SYS/broker/load/bytes/received/1min": "11769.25"
},
{
"$SYS/broker/load/bytes/sent/1min": "18819.48"
},
{
"$SYS/broker/load/sockets/1min": "0.77"
},
{
"$SYS/broker/load/connections/1min": "0.77"
},
{
"$SYS/broker/load/messages/received/5min": "38.64"
},
{
"$SYS/broker/load/messages/sent/5min": "64.31"
},
{
"$SYS/broker/load/publish/received/5min": "29.91"
},
{
"$SYS/broker/load/publish/sent/5min": "55.59"
},
{
"$SYS/broker/load/bytes/received/5min": "10591.17"
},
{
"$SYS/broker/load/bytes/sent/5min": "12697.14"
},
{
"$SYS/broker/load/messages/sent/15min": "48.93"
},
{
"$SYS/broker/load/publish/received/15min": "29.82"
},
{
"$SYS/broker/load/publish/sent/15min": "40.61"
},
{
"$SYS/broker/load/bytes/received/15min": "10381.81"
},
{
"$SYS/broker/load/bytes/sent/15min": "11260.39"
},
{
"$SYS/broker/store/messages/bytes": "503"
},
{
"$SYS/broker/messages/received": "5458757"
},
{
"$SYS/broker/messages/sent": "5445308"
},
{
"$SYS/broker/publish/messages/received": "4301473"
},
{
"$SYS/broker/publish/messages/sent": "4288279"
},
{
"$SYS/broker/bytes/received": "1484799070"
},
{
"$SYS/broker/bytes/sent": "1484829223"
},
{
"$SYS/broker/publish/bytes/received": "1388003431"
},
{
"$SYS/broker/publish/bytes/sent": "1388196208"
},
{
"sys/FFFF/master": "{ 'sn': 'CARL61D00377A', 'devModel': 'EG310G-E', 'mac': '54:16:51:47:F1:37', 'tipcInst': 1196499365, 'software': 'ReyeeOS 1.95.1815;EG_3.0(1)B11P95,Release(09181516)', 'protoVer': 3 }"
},
{
"sys/001/alarm_del": "{ 'list': [ 180 ] }"
},
{
"sys/FFFF/master": "{ 'sn': 'CARL61D00377A', 'devModel': 'EG310G-E', 'mac': '54:16:51:47:F1:37', 'tipcInst': 1196499365, 'software': 'ReyeeOS 1.95.1815;EG_3.0(1)B11P95,Release(09181516)', 'protoVer': 3 }"
},
{
"sys/FFFF/master": "{ 'sn': 'CARL61D00377A', 'devModel': 'EG310G-E', 'mac': '54:16:51:47:F1:37', 'tipcInst': 1196499365, 'software': 'ReyeeOS 1.95.1815;EG_3.0(1)B11P95,Release(09181516)', 'protoVer': 3 }"
}
]
}
Changelog¶
v1.1.0 (2025-09-10)¶
- Updated to use the new targeting library (
pkg/targeting) instead of the old external targeting library
v1.0.0 (2025-05-05)¶
- Initial release of versioning for each module. All modules are being tagged with version number
1.0.0. Going forward: - Major version should be changed when there are changes that impact consumers or clients of the modules.
- Minor version should be changed when there are additions which enrich or enhance the module but shouldn't affect consumers or clients.
- Patch version should be changed when there are bugfixes.