This is a fork of the original sensniff software by g-oikonomou. The main changes are just some default parameters to make it easier to use with freaklabs 802.15.4 boards. There's also plans to add more commands in the future beyond get/set channel.
Live Traffic Capture and Sniffer for IEEE 802.15.4 networks.
This tool helps you perform live traffic capture and analysis for IEEE 802.15.4 networks. sensniff has two components:
- Peripheral: This is an embedded device with a .15.4 trasceiver which captures all network frames and streams them over to the host.
- Host: This is a python script which runs on a PC. It reads network packets captured by the peripheral, converts them to PCAP and pipes them to wireshark.
Other than network packet capture, the host can send commands to the peripheral to achieve secondary functionality e.g. change radio channel.
sensniff is distributed under the terms of the 3-clause BSD license. See LICENSE.
sensniff has been developed and tested on Ubuntu and Mac OS X. sensniff does not work on Windows (and most likely never will).
How to Use
In a nutshell, three steps are involved:
- Program your peripheral with a sensniff-compliant firmware and connect it to your PC
- Run the host tool (resides in
- Run wireshark, start a capture and enjoy
Program your Peripheral
First, you need to have a device with a .15.4 transceiver and you need to program the device with a sniffer firmware. Here, we have the following options:
- Contiki OS firmware
- sensniff firmware
Sensniff with Contiki
Contiki currently provides sensniff-compatible projects for the following hardware platforms:
- Texas Instruments CC2538 devices. This will work with a CC2538 EM in CDC-ACM mode, as well as with Srf06EB+CC2538EM over UART.
- Texas Instruments CC2530 devices. This will work with CC2531 USB dongles as well as CC2530 Evaluation Modules on a SmartRF 05 Evaluation Board
$(CONTIKI)/examples/cc2530dk/sniffer. Some problems have been reported when using the CC2531 USB dongle. See #5.
- Sensinode N601 USB NanoRouters and N740 NanoSensors:
$(CONTIKI)/examples/sensinode/sniffer. This has not been tested for a while.
- Contiki's port for the OpenMote platform also provides a sniffer example. The port is currently under consideration for inclusion in the main Contiki repo.
In the near future, sensniff will also provide sources for a series of wireless sensor platforms. The first platforms to be supported will be the same as those with examples in the Contiki source tree (see above). These will slowly start appearing in the
Run the Host Tool
The host-side tool assumes that the peripheral appears as a serial port on the host PC. If your embedded device has a native USB interface, it will have to enumerate as a CDC-ACM device (e.g. the CC2531 USB dongle running the Contiki sniffer example).
The best way to start:
python sensniff.py -h
- To read captures from
python sensniff.py -d /dev/ttyUSB1
- To run in non-interactive mode:
python sensniff.py --non-interactive
- To increase verbosity:
python sensniff.py -D INFO
- Use the
-pargument to save the capture in a pcap file:
python sensniff.py -p
The host-side script will also print out peripheral debugging output. Any data received not starting with the correct MAGIC (see protocol specification) will be considered to be debugging output from the peripheral and will be printed verbatim, prefixed by 'Peripheral: '. Thus, you may see something like this:
Peripheral: sniffer: Command 0x82 Peripheral: sniffer: SET_CHANNEL command Peripheral: sniffer: Channel 12 Received a command response: [01 0c] Sniffing in channel: 12 Peripheral: sniffer: Response [ 53 6e 69 66 01 01 01 0c ]
The host-side tool will convert the frames to PCAP format and pipe them to a FIFO file. All you need to do is to set wireshark to start a capture, using this FIFO file as the capture 'interface'. By default, sensniff will use
Go to Capture -> options -> Manage Interfaces -> New (under Pipes) -> type
/tmp/sensniff and save. The pipe will then appear as an interface. Start a capture on it.
In older versions of Wireshark, go to Capture -> Options and type
/tmp/sensniff in the Interface field.
You don't need root priviledges.
The first time your run this, you will need to open Wireshark's preferences and select 'TI CC24xx FCS format' under Protocols -> IEEE 802.15.4. You will also need to correctly configure contexts under 6LoWPAN.
For Host-Peripheral communication, sensniff uses its own minimalistic protocol. The host tool currently suports two version of the protocol:
- Current version: This is specified in this README. All future examples and peripheral code will use this version.
- Legacy version: This is not documented here and will fade away, eventually. This version only supports frame capturing. Host-initiated commands are not supported.
The host-side script has been tested extensively and should work without major issues. It supports both versions of the sensniff protocol but the legacy version will be removed without any notice.
The examples in the Contiki tree currently use the legacy protocol version
This means that:
- Only frame capturing is supported. Host-to-Peripheral commands are not.
- The frame format is different to what is documented in this page.
Both examples are going to get updated to the current protocol version in the very short term. As a result of this, they will also support host-initiated commands. Once these changes have been merged with Contiki's upstream, support for the legacy protocol will disappear.
How to add support for your Device
If your device is supported by Contiki, things are pretty simple:
$(CONTIKI)/cpu/cc253x/dev/cc2530-rf.c. Look for the lines wrapped inside
CC2530_RF_CONF_HEXDUMPand this will make it obvious what you need to do to your own device's radio driver.
$(CONTIKI)/examples/cc2530dk/snifferto a new example directory.
stub-rdc.cwill not need modified. Slight changes may be needed in
sniffer.cto turn off the frame filtering functionality of your RF chip.
Make sure you have read the 'Project Status' section of this README.
How to Contribute
- Bug reports: Open a new issue [https://github.com/g-oikonomou/sensniff/issues]
- Patches: Please submit them through pull requests [https://github.com/g-oikonomou/sensniff/pulls]
sensniff Host-to-Peripheral protocol
sensniff uses a minimalistic protocol for the communication between the host and the peripheral. All packets (in both directions) follow this format:
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 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | MAGIC | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | VERSION | CMD | LEN + | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + | DATA | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
- MAGIC: The following 4 bytes (hex): C1 1F FE 52 ('S'+'n' 1F FE 'r')
- VERSION: (1 byte). Currently 1.
- CMD: (1 byte) Command. See below for possible values.
- LEN: (1 byte) Length of the DATA field in number of bytes. Optional.
- DATA: Variable length specified in LEN. Only transmitted if LEN exists and has value > 0. Contains the payload, depending on the value of CMD.
Generally speaking, frames with the MS bit of the CMD field set are host-to-peripheral. The MS bit is clear for peripheral-to-host packets.
The CMD field can take the following values:
- CMD==0x00 (CMD_FRAME): LEN will contain the length of a captured .15.4 frame. DATA will contain the frame itself, including the .15.4 MAC layer header, payload and FCS. This command is peripheral-initiated.
- CMD==0x01 (CMD_CHANNEL): The current RF channel used by the peripheral's transceiver. LEN will be 1. DATA will be 1 byte long and will contain the value of the channel. Valid values in [11,26]. Packets of this type are always a response to either CMD_GET_CHANNEL or CMD_SET_CHANNEL.
- CMD==0x81 (CMD_GET_CHANNEL): Used by the host to query the current radio channel used by the peripheral's RF chip. LEN and DATA are omitted. The Peripheral will respond with a CMD_CHANNEL.
- CMD==0x82 (CMD_SET_CHANNEL): Used by the host to request a change to a new radio channel. LEN will be 1. DATA will be 1 byte long and will contain the value of the new channel. Valid values in [11,26]. The peripheral will respond with a CMD_CHANNEL.
sensniff does not perform any error checking. Thus, if a frame appears broken on wireshark:
- It may have been sent incorrectly by the originator
- It may have been received incorrectly by the sniffer
- It may have broken during the peripheral-to-host transfer
- It may have broken during the host-to-wireshark piping (very unlikely)
There is no way of knowing which of the above is the cause.