Skip to content

MQTTInfo

The MQTTInfo module attempts to connect to a MQTT server and run a series of commands to test its capabilities / enabled features.

MQTTInfo Request Example

curl -v -L https://api.binaryedge.io/v1/tasks -d '{"type":"scan", "options":[{"targets":["X.X.X.X"], "ports":[{"port":1883, "protocol":"tcp", "modules":["mqttinfo"]}]}]}' -H "X-Token:<Token>"

MQTTInfo Request Options

These are optional parameters that can alter the behaviour of the module. These options can be inserted into the "config" object on the request.

  • mqtts - Whether to use MQTTS instead of MQTT
    • "config":{"mqtts":true}
  • ipv6 - Whether to use IPv6 instead of IPv4
    • "config":{"ipv6":true}

Schema

MQTTInfo Event Schema

{
  ...
  "result": {
    "data": {
      "v4": {
        "invalid_utf8_topic": "boolean",
        "qo_s1": "boolean",
        "publish_sys": "boolean",
        "filter_sys": "boolean",
        "qo_s2": "boolean",
        "invalid_topics": "boolean",
        "supported": "boolean",
        "qo_s3_response": "boolean",
        "anonymous": "boolean",
        "subscribe_all": "boolean"
      },
      "v5": {
        "invalid_utf8_topic": "boolean",
        "qo_s1": "boolean",
        "publish_sys": "boolean",
        "filter_sys": "boolean",
        "qo_s2": "boolean",
        "invalid_topics": "boolean",
        "supported": "boolean",
        "qo_s3_response": "boolean",
        "anonymous": "boolean",
        "subscribe_all": "boolean"
      }
    }
  ...
}

Contents of the fields

  • supported - Supports this version of the MQTT protocol (v4 / v5)
  • anonymous - Allows anonymous user
  • qo_s1 - Supports QoS1
  • qo_s2 - Supports QoS2
  • qo_s3_response - Supports QoS3
  • subscribe_all - Allows subscribe to #
  • invalid_topics - Allows invalid topics
  • invalid_utf8_topic - Allows invalid UTF-8
  • publish_sys - Allows $SYS publishes
  • filter_sys - Filters $SYS publishes

MQTTInfo Event Example

{
  ...
  "result": {
    "data": {
      "v4": {
        "invalid_utf8_topic": false,
        "qo_s1": true,
        "publish_sys": true,
        "filter_sys": true,
        "qo_s2": true,
        "invalid_topics": false,
        "supported": true,
        "qo_s3_response": false,
        "anonymous": true,
        "subscribe_all": true
      },
      "v5": {
        "invalid_utf8_topic": false,
        "qo_s1": true,
        "publish_sys": false,
        "filter_sys": true,
        "qo_s2": true,
        "invalid_topics": false,
        "supported": true,
        "qo_s3_response": false,
        "anonymous": true,
        "subscribe_all": true
      }
    }
  ...
}