scapy.contrib.mqtt

class scapy.contrib.mqtt.MQTT(*args: Any, **kargs: Any)[source]

Bases: scapy.packet.Packet

aliastypes

fields_desc

Display RFC-like schema

 0                   1                   2                   3
 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|  TYPE |D|QOS|R|              LEN              |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

                            Fig. MQTT

MQTT fields
type	`BitEnumField`	`1`
DUP	`BitEnumField`	`0`
QOS	`BitEnumField`	`0`
RETAIN	`BitEnumField`	`0`
len	`VariableFieldLenField`	`None`

payload_guess: Possible sublayers: MQTTConnack, MQTTConnect, MQTTDisconnect, MQTTPuback, MQTTPubcomp, MQTTPublish, MQTTPubrec, MQTTPubrel, MQTTSuback, MQTTSubscribe, MQTTUnsuback, MQTTUnsubscribe

class scapy.contrib.mqtt.MQTTConnack(*args: Any, **kargs: Any)[source]

Bases: scapy.packet.Packet

aliastypes

fields_desc

Display RFC-like schema

 0                   1                   2                   3
 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|SESSPRESENTFLAG|    RETCODE    |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

                         Fig. MQTTConnack

MQTTConnack fields
sessPresentFlag	`ByteField`	`0`
retcode	`ByteEnumField`	`0`

payload_guess: Possible sublayers: MQTT

class scapy.contrib.mqtt.MQTTConnect(*args: Any, **kargs: Any)[source]

Bases: scapy.packet.Packet

aliastypes

fields_desc

Display RFC-like schema

 0                   1                   2                   3
 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|             LENGTH            |           PROTONAME           |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|   PROTOLEVEL  |U|P|W|WIL|W|C|R|             KLIVE             |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|          CLIENTIDLEN          |            CLIENTID           |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|            WTOPLEN            |           WILLTOPIC           |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|            WMSGLEN            |            WILLMSG            |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|            USERLEN            |            USERNAME           |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|            PASSLEN            |            PASSWORD           |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

                         Fig. MQTTConnect

MQTTConnect fields
length	`FieldLenField`	`None`
protoname	`StrLenField`	`b''`
protolevel	`ByteEnumField`	`5`
usernameflag	`BitEnumField`	`0`
passwordflag	`BitEnumField`	`0`
willretainflag	`BitEnumField`	`0`
willQOSflag	`BitEnumField`	`0`
willflag	`BitEnumField`	`0`
cleansess	`BitEnumField`	`0`
reserved	`BitEnumField`	`0`
klive	`ShortField`	`0`
clientIdlen	`FieldLenField`	`None`
clientId	`StrLenField`	`b''`
wtoplen	`FieldLenField` (Cond)	`None`
willtopic	`StrLenField` (Cond)	`b''`
wmsglen	`FieldLenField` (Cond)	`None`
willmsg	`StrLenField` (Cond)	`b''`
userlen	`FieldLenField` (Cond)	`None`
username	`StrLenField` (Cond)	`b''`
passlen	`FieldLenField` (Cond)	`None`
password	`StrLenField` (Cond)	`b''`

payload_guess: Possible sublayers: MQTT

class scapy.contrib.mqtt.MQTTDisconnect(*args: Any, **kargs: Any)[source]

Bases: scapy.packet.Packet

aliastypes

fields_desc

payload_guess: Possible sublayers: MQTT

class scapy.contrib.mqtt.MQTTPuback(*args: Any, **kargs: Any)[source]

Bases: scapy.packet.Packet

aliastypes

fields_desc

Display RFC-like schema

 0                   1                   2                   3
 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|             MSGID             |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

                         Fig. MQTTPuback

MQTTPuback fields
msgid	`ShortField`	`None`

payload_guess: Possible sublayers: MQTT

class scapy.contrib.mqtt.MQTTPubcomp(*args: Any, **kargs: Any)[source]

Bases: scapy.packet.Packet

aliastypes

fields_desc

Display RFC-like schema

 0                   1                   2                   3
 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|             MSGID             |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

                         Fig. MQTTPubcomp

MQTTPubcomp fields
msgid	`ShortField`	`None`

payload_guess: Possible sublayers: MQTT

class scapy.contrib.mqtt.MQTTPublish(*args: Any, **kargs: Any)[source]

Bases: scapy.packet.Packet

aliastypes

fields_desc

Display RFC-like schema

 0                   1                   2                   3
 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|             LENGTH            |             TOPIC             |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|             MSGID             |             VALUE             |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

                         Fig. MQTTPublish

MQTTPublish fields
length	`FieldLenField`	`None`
topic	`StrLenField`	`b''`
msgid	`ShortField` (Cond)	`None`
value	`StrLenField`	`b''`

payload_guess: Possible sublayers: MQTT

class scapy.contrib.mqtt.MQTTPubrec(*args: Any, **kargs: Any)[source]

Bases: scapy.packet.Packet

aliastypes

fields_desc

Display RFC-like schema

 0                   1                   2                   3
 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|             MSGID             |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

                         Fig. MQTTPubrec

MQTTPubrec fields
msgid	`ShortField`	`None`

payload_guess: Possible sublayers: MQTT

class scapy.contrib.mqtt.MQTTPubrel(*args: Any, **kargs: Any)[source]

Bases: scapy.packet.Packet

aliastypes

fields_desc

Display RFC-like schema

 0                   1                   2                   3
 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|             MSGID             |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

                         Fig. MQTTPubrel

MQTTPubrel fields
msgid	`ShortField`	`None`

payload_guess: Possible sublayers: MQTT

class scapy.contrib.mqtt.MQTTSuback(*args: Any, **kargs: Any)[source]

Bases: scapy.packet.Packet

aliastypes

fields_desc

Display RFC-like schema

 0                   1                   2                   3
 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|             MSGID             |    RETCODE    |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

                         Fig. MQTTSuback

MQTTSuback fields
msgid	`ShortField`	`None`
retcode	`ByteEnumField`	`None`

payload_guess: Possible sublayers: MQTT

class scapy.contrib.mqtt.MQTTSubscribe(*args: Any, **kargs: Any)[source]

Bases: scapy.packet.Packet

aliastypes

fields_desc

Display RFC-like schema

 0                   1                   2                   3
 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|             MSGID             |             TOPICS            |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

                        Fig. MQTTSubscribe

MQTTSubscribe fields
msgid	`ShortField`	`None`
topics	`PacketListField`	`[]`

payload_guess: Possible sublayers: MQTT

class scapy.contrib.mqtt.MQTTTopic(*args: Any, **kargs: Any)[source]

Bases: scapy.packet.Packet

aliastypes

fields_desc

Display RFC-like schema

 0                   1                   2                   3
 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|             LENGTH            |             TOPIC             |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

                          Fig. MQTTTopic

MQTTTopic fields
length	`FieldLenField`	`None`
topic	`StrLenField`	`b''`

guess_payload_class(payload)[source]

class scapy.contrib.mqtt.MQTTTopicQOS(*args: Any, **kargs: Any)[source]

Bases: scapy.contrib.mqtt.MQTTTopic

aliastypes

fields_desc

Display RFC-like schema

 0                   1                   2                   3
 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|             LENGTH            |             TOPIC             |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|      QOS      |
+-+-+-+-+-+-+-+-+

                        Fig. MQTTTopicQOS

MQTTTopicQOS fields
length	`FieldLenField`	`None`
topic	`StrLenField`	`b''`
QOS	`ByteEnumField`	`0`

class scapy.contrib.mqtt.MQTTUnsuback(*args: Any, **kargs: Any)[source]

Bases: scapy.packet.Packet

aliastypes

fields_desc

Display RFC-like schema

 0                   1                   2                   3
 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|             MSGID             |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

                        Fig. MQTTUnsuback

MQTTUnsuback fields
msgid	`ShortField`	`None`

payload_guess: Possible sublayers: MQTT

class scapy.contrib.mqtt.MQTTUnsubscribe(*args: Any, **kargs: Any)[source]

Bases: scapy.packet.Packet

aliastypes

fields_desc

Display RFC-like schema

 0                   1                   2                   3
 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|             MSGID             |             TOPICS            |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

                       Fig. MQTTUnsubscribe

MQTTUnsubscribe fields
msgid	`ShortField`	`None`
topics	`PacketListField`	`[]`

payload_guess: Possible sublayers: MQTT

class scapy.contrib.mqtt.RandVariableFieldLen[source]: Bases: scapy.volatile.RandNum

class scapy.contrib.mqtt.VariableFieldLenField(name: str, default: Optional[Any], length_of: Optional[str] = None, fmt: str = 'H', count_of: Optional[str] = None, adjust: Callable[[Packet, int], int] = <function FieldLenField.<lambda>>)[source]

Bases: scapy.fields.FieldLenField

addfield(pkt, s, val)[source]

getfield(pkt, s)[source]

randval()[source]