Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/helium/lorawan-sniffer
https://github.com/helium/lorawan-sniffer
Last synced: 5 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/helium/lorawan-sniffer
- Owner: helium
- License: apache-2.0
- Created: 2020-03-18T17:25:27.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2022-07-21T15:57:04.000Z (over 2 years ago)
- Last Synced: 2024-04-14T17:00:32.422Z (7 months ago)
- Language: Rust
- Size: 106 KB
- Stars: 12
- Watchers: 31
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://travis-ci.com/helium/lorawan-sniffer)
# lorawan-sniffer
Download a compiled release [here](https://github.com/helium/lorawan-sniffer/releases).
## Features
LoRaWAN Sniffer is a utility which allows you to sniff and parse as LoRaWAN the UDP traffic to and from any packet forwarder that uses the Semtech UDP protocol.
If you load device information into the utility, session keys are derived during Over-the-Air-Authentication (OTAA) and data frames will be decrypted. Currently, ABP is not supported.
## Usage
The Sniffer only works if you enable the "mirror port" on the Miner. In the file `/opt/miner/releases/0.1.0/sys.config` you want to add `{radio_mirror_port, 1681},` after the line `{use_ebus, true},`. Or in sed speak:
```bash
sed -i '/{use_ebus, true},/ a \ \ \ {radio_mirror_port, 1681},' /opt/miner/releases/0.1.0/sys.config
```
The utility can also act as a passthrough; connect the packet forwarder to this utility (`0.0.0.0:1680`) and in turn, connect this utility to some host
Either way, starting up the utility is identical:
```
lorawan-sniffer -h 192.168.1.55:1681
```
If you want to use passthrough mode, you will need to connect your packet forward to the utility. For the Semtech packet foward, that means making changes to `global_conf.json`.
## Helium Image Quickstart
If you are using a production or development image of a Helium hotspot, you can use the `snipper_setup.sh` script to enable mirroring on the Helium Miner; the Miner will now forward a copy to all UDP traffic to port 1681 of the Hotspot IP
```
sniffer_setup.sh []
```
HotspotPW defaults to `hotspot`, the password of the development image. If you are using a production image, you will need to input the production image password.
## Loading Devices
Devices and their credentials may be loaded in two ways:
* by using a local file
* by loading the devices from Helium Console (requires API key)
To load devices by file, simply create a local file called `lorawan-devices.json` and provide a JSON array of devices:
```
[
{
"app_eui": "5F3BD74E6778AB9B",
"app_key": "EDC1A29400517C5312CFBFD5F56F69C2",
"dev_eui": "3B595A22646AA4D5"
}
]
```
To load devices from Console, use the console option:
```
lorawan-sniffer -h 192.168.1.55:1681 --console
```
If `.helium-console-config.toml` does not yet exist, you will be prompted for an API key and the file will be created, similar to when using the [Helium Console CLI](https://github.com/helium/helium-console-cli). Note that this file stores your API key in plain-text so only do this on trusted hosts.
## Example Session
Once everything is setup, you'll see output similar to this:
```
JoinRequest 906.3 MHz SF10BW125 RSSI: -69 LSNR: 11.8
AppEui: 5F3BD74E6778AB9B DevEui: 3B595B22646AA4D5 DevNonce: 7995
JoinAccept 925.7 MHz SF10BW500
AppNonce: E79DE9 NetId: 326548 DevAddr: 4ED73B5F
DL Settings: DLSettings(0) RxDelay: 0
Newskey: AES128([5F, 66, BE, 9A, 4, 29, 9E, 12, 58, 5E, F4, 13, F1, B7, 3, A0])
Appskey: AES128([F1, 9E, B3, C, EC, 3E, BA, 81, B0, BF, EC, BB, 1E, 97, A0, 20])
UnconfirmedDataUp 905.5 MHz SF10BW125 RSSI: -69 LSNR: 11.5
DevAddr: 4ED73B5F, FCtrl(80, true), FCnt(0), FPort(1),
Decrypted(Data([de, ad, be, ef, 1]))
UnconfirmedDataDown 923.3 MHz SF10BW500
DevAddr: 4ED73B5F, FCtrl(a, true), FCnt(0)
[LinkADRAns(LinkADRAnsPayload([0]))]
UnconfirmedDataUp 906.3 MHz SF10BW125 RSSI: -69 LSNR: 11.8
DevAddr: 4ED73B5F, FCtrl(84, true), FCnt(1)
[LinkADRAns(LinkADRAnsPayload([6])), LinkADRAns(LinkADRAnsPayload([6]))]
UnconfirmedDataUp 906.7 MHz SF10BW125 RSSI: -66 LSNR: 10.2
DevAddr: 4ED73B5F, FCtrl(80, true), FCnt(2), FPort(1),
Decrypted(Data([de, ad, be, ef, 2]))
UnconfirmedDataUp 906.9 MHz SF10BW125 RSSI: -69 LSNR: 11.2
DevAddr: 4ED73B5F, FCtrl(80, true), FCnt(3), FPort(1),
Decrypted(Data([de, ad, be, ef, 3]))
```