Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mqtt-tools/mqttshark
MQTT formatter for tshark, the terminal network packet capture tool.
https://github.com/mqtt-tools/mqttshark
Last synced: about 1 month ago
JSON representation
MQTT formatter for tshark, the terminal network packet capture tool.
- Host: GitHub
- URL: https://github.com/mqtt-tools/mqttshark
- Owner: mqtt-tools
- License: gpl-3.0
- Created: 2023-02-17T23:35:42.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-05-08T21:52:07.000Z (8 months ago)
- Last Synced: 2024-05-08T22:33:40.743Z (8 months ago)
- Language: Python
- Homepage:
- Size: 181 KB
- Stars: 17
- Watchers: 3
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: COPYING
Awesome Lists containing this project
README
# mqttshark - MQTT formatter for tshark
mqttshark will run tshark, the terminal network packet capture tool, and
attempt to pretty print any MQTT messages received.
It can decode MQTT packets tunnelled over WebSockets, and can decode TLS
packets when pre-keys are available.
mqttshark requires at least Python 3.6, and possibly something more recent than
that. It also requires tshark to be installed.
## Usage
Run listening to port 1883 on the first non-loopback network interface:
```
mqttshark
# Run a test
mosquitto_sub -h test.mosquitto.org -t '$SYS/broker/uptime' -t sub-2 -U unsub-1 -U unsub-2 \
-q 2 -V 5 --will-topic will-topic --will-payload payload
```
Run on a specific network interface:
```
mqttshark -i eth0
```
Further examples:
```
mqttshark -p 1234:mqtt # Listen on port 1234, decoding as MQTT
mqttshark -p 1234:mqtts --tls-keylog # Listen on port 1234, decoding as MQTT over TLS.
mqttshark -p 1234:ws # Listen on port 1234, decoding as WebSockets
mqttshark -p 1234:mqtts --tls-keylog # Listen on port 1234, decoding as MQTT over WebSockets over TLS.
mqttshark -p 1883:mqtt,8883:mqtts,8080:ws,8081:wss # Listen on multiple ports
```
There are lots of ways of choosing how to display the output and suppress /
pick which packets to display, see the help:
```
mqttshark -h
```
## Display
This explains the meaning of some of the output:
## Bugs
* Will properties are not displayed - this seems to be a missing feature in tshark
* Payloads with new lines may cause problems
## Contact
https://github.com/mqtt-tools/mqttshark