URH image

Build Status PyPI version Packaging status Blackhat Arsenal 2017 Blackhat Arsenal 2018

The Universal Radio Hacker (URH) is a complete suite for wireless protocol investigation with native support for many common Software Defined Radios. URH allows easy demodulation of signals combined with an automatic detection of modulation parameters making it a breeze to identify the bits and bytes that fly over the air. As data often gets encoded before transmission, URH offers customizable decodings to crack even sophisticated encodings like CC1101 data whitening. When it comes to protocol reverse-engineering, URH is helpful in two ways. You can either manually assign protocol fields and message types or let URH automatically infer protocol fields with a rule-based intelligence. Finally, URH entails a fuzzing component aimed at stateless protocols and a simulation environment for stateful attacks.

Getting started

In order to get started

If you like URH, please :star: this repository and join our Slack channel. We appreciate your support!

Citing URH

We encourage researchers working with URH to cite this WOOT'18 paper or directly use the following BibTeX entry.

URH BibTeX entry for your research paper ```bibtex @inproceedings {220562, author = {Johannes Pohl and Andreas Noack}, title = {Universal Radio Hacker: A Suite for Analyzing and Attacking Stateful Wireless Protocols}, booktitle = {12th {USENIX} Workshop on Offensive Technologies ({WOOT} 18)}, year = {2018}, address = {Baltimore, MD}, url = {https://www.usenix.org/conference/woot18/presentation/pohl}, publisher = {{USENIX} Association}, } ```


URH runs on Windows, Linux and macOS. Click on your operating system below to view installation instructions.

On Windows, URH can be installed with its [Installer](https://github.com/jopohl/urh/releases). No further dependencies are required. If you get an error about missing ```api-ms-win-crt-runtime-l1-1-0.dll```, run Windows Update or directly install [KB2999226](https://support.microsoft.com/en-us/help/2999226/update-for-universal-c-runtime-in-windows).
Generic Installation with pip (recommended)
URH is available on [PyPi](https://pypi.org/project/urh/) so you can install it with ```bash # IMPORTANT: Make sure your pip is up to date sudo python3 -m pip install --upgrade pip # Update your pip installation sudo python3 -m pip install urh # Install URH ``` This is the recommended way to install URH on Linux because it comes with __all native extensions__ precompiled. In order to access your SDR as non-root user, install the according __udev rules__. You can find them [in the wiki](https://github.com/jopohl/urh/wiki/SDR-udev-rules).
Install via Package Manager
URH is included in the repositories of many linux distributions such as __Arch Linux__, __Gentoo__, __Fedora__, __openSUSE__ or __NixOS__. There is also a package for __FreeBSD__. If available, simply use your package manager to install URH. __Note__: For native support, you must install the according ```-dev``` package(s) of your SDR(s) such as ```hackrf-dev``` __before__ installing URH.
URH is available as a snap: https://snapcraft.io/urh
Docker Image
The official URH docker image is available [here](https://hub.docker.com/r/jopohl/urh/). It has all native backends included and ready to operate.
Using DMG
It is recommended to use __at least macOS 10.14__ when using the DMG available [here](https://github.com/jopohl/urh/releases).
With pip
1. Install [Python 3 for Mac OS X](https://www.python.org/downloads/mac-osx/). _If you experience issues with preinstalled Python, make sure you update to a recent version using the given link._ 2. (Optional) Install desired native libs e.g. ```brew install librtlsdr``` for corresponding native device support. 3. In a terminal, type: ```pip3 install urh```. 4. Type ```urh``` in a terminal to get it started.
Update your installation
If you installed URH via pip you can keep it up to date with ``` python3 -m pip install --upgrade urh ```.
Running from source
Without installation
To execute the Universal Radio Hacker without installation, just run: ```bash git clone https://github.com/jopohl/urh/ cd urh/src/urh ./main.py ``` Note, before first usage the C++ extensions will be built.
Installing from source
To install URH from source you need to have ```python-setuptools``` installed. You can get them with ```python3 -m pip install setuptools```. Once the setuptools are installed execute: ```bash git clone https://github.com/jopohl/urh/ cd urh python setup.py install ``` And start the application by typing ```urh``` in a terminal.


Hacking stuff with URH

General presentations and tutorials on URH

External decodings

See wiki for a list of external decodings provided by our community! Thanks for that!


Get the data out of raw signals

Interpretation phase

Keep an overview even on complex protocols

Analysis phase

Record and send signals