expliot.plugins.mqtt.mqttpub

Plugin to publish to a topic on an MQTT broker.

Attributes

DEFAULT_MQTT_PORT

MQTT_REFERENCE

Classes

MqttClient

Wrapper on Paho MQTT Client class.

TCategory

Representation of Test Category.

Test

Representation of Test.

TLog

Representation of a Test Log.

TTarget

Representation of Test Target class.

MqttPub

Publish a MQTT message to a given MQTT broker.

Module Contents

expliot.plugins.mqtt.mqttpub.DEFAULT_MQTT_PORT = 1883
class expliot.plugins.mqtt.mqttpub.MqttClient(client_id='', clean_session=True, userdata=None, protocol=MQTTv311, transport='tcp')

Bases: paho.mqtt.client.Client

Wrapper on Paho MQTT Client class.

For more details on the functionality check, see https://github.com/eclipse/paho.mqtt.python

classmethod rcstr(retcode)

Returns a string representation of the return code.

Args:

retcode (int): MQTT Connection return code

Returns:

A string representation of the return code

on_connectcb(client, userdata, flags, retcode)

Default on_connect callback.

It sets the member with connection return code and disconnects on error. Used by pub and sub plugins.

Args:
client (MqttClient) - The MQTT client object. This is not

used as it is the same as self.

userdata (caller defined): Callback specific data passed in

__init__(). This is not used as we use self members to pass information.

flags (dict): A dict that contains response flags from the broker. retcode (int): MQTT Connection return code.

Returns:

Nothing.

on_publishcb(client, userdata, mid)

Default on_publish callback.

It disconnects the connection assuming the message has been published. Don’t use this if you want to send multiple messages in single conenction. Used by pub and sub plugins

Args:
client (MqttClient): The MQTT client object. This is not

used as it is the same as self.

userdata (caller defined): Callback specific data passed in

__init__(). This is not used as we use self members to pass information.

mid (int): matches the mid variable returned from the corresponding

publish() call

Returns:

Nothing.

on_disconnectcb(client, userdata, retcode)

Default on_disconnect callback.

It sets the member with disconnection return code and disconnects on error. Used by pub and sub plugins. If the retiurn code is not zero i.e. MQTT_ERR_SUCCESS it means that this callback is called because of an unexpected disconnection from the broker. If it is zero, it is called as a result of self.disconnect() call. We call disconnect() to make sure the object stops looping in loop*() methods in the pub sub plugins.

Args:
client (MqttClient) - The MQTT client object. This is not

used as it is the same as self.

userdata (caller defined): Callback specific data passed in

__init__(). This is not used as we use self members to pass information.

retcode (int): MQTT Disconnection return code. This is not a correct

indication of the error as it returns default connection error return code.

Returns:

Nothing.

easy_config(user=None, passwd=None, on_connect=None, on_publish=None, on_subscribe=None, on_message=None, on_disconnect=None)

Easy configuration for MqttClient.

It sets the username, password and default callbacks required by the pub sub plugins.

Args:

user (str): MQTT Username passwd (str): MQTT Password on_connect (callback): On connect Callback to be set on_publish (callback): On publish Callback to be set on_subscribe (callback): On subscribe Callback to be set on_message (callback): On message Callback to be set on_disconnect (callback): On disconnect Callback to be set

Returns:

Nothing.

class expliot.plugins.mqtt.mqttpub.TCategory(tech, iface, action)

Bases: namedtuple('TCategory', 'tech, iface, action')

Representation of Test Category.

The class that defines the category of the test case. It is part of the Test class member _category. It can be used to identify the type of test or search for a specific category. It is a namedtuple that defines three attributes (for categorizing test cases).

  1. tech: What technology does the test use

  2. iface: Interface of the test i.e. whether it is for software or hardware

  3. action: What action does the test perform i.e. is it an exploit or a

    recon test for example.

COAP = 'coap'
DICOM = 'dicom'
HTTP = 'http'
MDNS = 'mdns'
MODBUS = 'modbus'
MQTT = 'mqtt'
TCP = 'tcp'
TLS = 'tls'
UDP = 'udp'
UPNP = 'upnp'
BLE = 'ble'
IEEE802154 = '802154'
ZIGBEE = 'zigbee'
CAN = 'can'
I2C = 'i2c'
JTAG = 'jtag'
SPI = 'spi'
UART = 'uart'
CRYPTO = 'crypto'
FW = 'firmware'
DISCLOSURE = 'disclosure'
ZB_AUDITOR = 'zbauditor'
BUS_AUDITOR = 'busauditor'
FW_AUDITOR = 'fwauditor'
NMAP = 'nmap'
_tech
HW = 'hardware'
RD = 'radio'
SW = 'software'
_interfaces
ANALYSIS = 'analysis'
COMPLIANCE = 'compliance'
DISCOVERY = 'discovery'
EXPLOIT = 'exploit'
FUZZ = 'fuzz'
RECON = 'recon'
_actions
class expliot.plugins.mqtt.mqttpub.Test(**kwargs)

Representation of Test.

The Base class for test cases (plugins). It defines the basic interface and basic implementation for the test cases. All test case plugins need to inherit from a test class derived from this class or this class itself depending on the purpose of the test case.

pre()

Action to take before the test.

post()

Action to take after the test.

execute()

Execute the test.

intro()

Show the intro for test.

output_dict_iter(cblog, robj, rlevel, key=None, value=None)

Callback method for recurse_list_dict().

It iterates over the dict

output passed from a plugin to output_handler(). It performs two operations on the dict

  1. If the output data is to be TLog(ged) (LOGPRETTY) on the console, then log the data recursively from the dict.

  2. Convert any bytes or bytearray objects in the dict to binary string and update the original dict object itself.

Args:
cblog (dict): Contains logging information i.e. to log the data or not?

and the Log prefix type.

robj (list or dict): The list or dict object at the specified recursion

level. This is updated by this callback i.e. bytes and bytearray objects found are converted to binary strings.

rlevel (int): The current recursion level at which this callback

instance is called.

key (str): The key if the robj is a dict. value (can be any type): 1. The value of the key if robj is a dict or

  1. A value from the robj if it is a list

Returns:

Nothing

output_handler(tlogtype=TLog.SUCCESS, msg=None, logkwargs=LOGPRETTY, **kwargs)

Handle the Test execution output data.

  • Add(append) data (dict) as an item in the TResult output (list).

  • And/or Log (print) the output

Args:
tlogtype (int): TLog prefix type to use i.e. Success, fail etc.

Check TLog class for prefix details.

msg (str): Specify a message to be logged, if any, apart from

output data.

logkwargs=LOGPRETTY(int): There are three options for kwargs logging

LOGPRETTY(0) - formatted logging for dict or list. LOGNORMAL(1) - Direct print of dict or list as is. LOGNO(2) - Do not log kwargs.

**kwargs: plugin output keyword arguments (or a **dictObject)

Returns:

Nothing.

run(arglist)

Run the test.

Args:

arglist (list): The argument list of the plugin.

Returns:
dict: The plugin result (status and output) on success,

or an empty dict in case of any error.

_assertpriv()

Raise an exception if the plugin needs root privileges.

Only if program is not executing as root.

Args:

None

Returns:

Nothing

_setid()

Set the Unique Test ID.

The ID is the plugin class name in lowercase.

Args:

None

Returns:

Nothing

_logstatus()

Handle the log status.

Args:

None

Returns:

Nothing

class expliot.plugins.mqtt.mqttpub.TLog

Representation of a Test Log.

Logger class for logging test case output. By default log to sys.stdout Must not instantiate. Use class methods. The logger needs to be initialized with the output file using init() class method

SUCCESS = 0
FAIL = 1
TRYDO = 2
GENERIC = 3
_prefix = ['[+]', '[-]', '[?]', '[*]']
_errprefix = '[.]'
_file
classmethod init(file=None)

Initialize the file object.

This method should be called in the beginning of the application to open the log output file.

Parameters:

file – The file where to log the test output

Returns:

classmethod close()

Close the file object if it is not sys.stdout.

Returns:

classmethod print(prefixtype, message)

The actual print methods.

Write the formatted message to the _file file.

Args:

prefixtype(int): the prefix type to be used for the message (defined above) message(str): The actual message from the Test object

Returns:

Nothing

classmethod success(message)

Write a message with success prefix to the file.

Parameters:

message – The message to be written

Returns:

classmethod fail(message)

Write a message with fail prefix to the file.

Parameters:

message – The message to be written

Returns:

classmethod trydo(message)

Write a message with try prefix to the file.

Parameters:

message – The message to be written

Returns:

void

classmethod generic(message)

Write a message with success prefix to the file.

Parameters:

message – The message to be written

Returns:

void

class expliot.plugins.mqtt.mqttpub.TTarget(name, version, vendor)

Bases: namedtuple('TTarget', 'name, version, vendor')

Representation of Test Target class.

Class that hold details about the target of the test. It is a namedtuple and holds the below details:

  1. name - Target/product name

  2. version - Version of the product

  3. vendor - Vendor that owns the product

Please note, in case it is a generic test case that can be used for multiple products use Target.GENERIC for all attributes.

GENERIC = 'generic'
LINUX = 'linux'
AWS = 'aws'
_name
AMAZON = 'amazon'
_vendor
expliot.plugins.mqtt.mqttpub.MQTT_REFERENCE = 'http://docs.oasis-open.org/mqtt/mqtt/v3.1.1/mqtt-v3.1.1.html'
class expliot.plugins.mqtt.mqttpub.MqttPub

Bases: expliot.core.tests.test.Test

Publish a MQTT message to a given MQTT broker.

Output Format: There is no output.

execute()

Execute the plugin.