Skip to main content

Universal Radio Hacker: investigate wireless protocols like a boss

Project description

URH image

Tests status Coverage PyPI version Packaging status Average time to resolve an issue Percentage of issues still open

Blackhat Arsenal 2017 Blackhat Arsenal 2018 Slack

The Universal Radio Hacker (URH) is a software for investigating unknown wireless protocols. Features include

  • hardware interfaces for common Software Defined Radios
  • easy demodulation of signals
  • assigning participants to keep an overview of your data
  • customizable decodings to crack even sophisticated encodings like CC1101 data whitening
  • assign labels to reveal the logic of the protocol
  • automatic reverse engineering of protocol fields
  • fuzzing component to find security leaks
  • modulation support to send the data back to the target
  • simulation environment to perform stateful attacks

Getting started

In order to get started

If URH is useful for you, please consider giving this repository a :star: or make donation via PayPal. We appreciate your support!

Want to stay in touch? :speech_balloon: Join our Slack channel!

Citing URH

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

@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},
}

Installation

Universal Radio Hacker can be installed via pip or using the package manager of your distribution (if included). Below you find more specific installation instructions for:

Windows

On Windows, URH can be installed with its Installer. 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.

Linux

Generic Installation with pip (recommended)

URH is available on PyPi so you can install it with

# 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.

udev rules

In order to access your SDR as non-root user, install the according udev rules. For example, you can install the HackRF udev rules with the following commands.

sudo tee -a /etc/udev/rules.d/52-hackrf.rules >/dev/null <<-EOF
ATTR{idVendor}=="1d50", ATTR{idProduct}=="604b", SYMLINK+="hackrf-jawbreaker-%k", MODE="660", GROUP="plugdev"
ATTR{idVendor}=="1d50", ATTR{idProduct}=="6089", SYMLINK+="hackrf-one-%k", MODE="660", GROUP="plugdev"
ATTR{idVendor}=="1fc9", ATTR{idProduct}=="000c", SYMLINK+="hackrf-dfu-%k", MODE="660", GROUP="plugdev"
EOF
sudo udevadm control --reload-rules

Make sure your current user is in the plugdev group to make these rules work. You find rules for other SDRs by searching for "<SDR name> udev rules" in your favorite search engine.

If you still have problems accessing your SDR the Linux USB autosuspend feature might be interfering. You can disable it by editing your /etc/default/grub as shown here.

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.

Docker Image

The official URH docker image is available here. It has all native backends included and ready to operate.

MacOS

Using DMG

It is recommended to use at least macOS 10.14 when using the DMG available here.

With pip

  1. Install Python 3 for Mac OS X. 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 pip3 install --upgrade urh, or, if this should not work python3 -m pip install --upgrade urh.

Running from source

If you like to live on bleeding edge, you can run URH from source.

Without installation

To execute the Universal Radio Hacker without installation, just run:

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 from source you need to have python-setuptools installed. You can get it e.g. with pip install setuptools. Once the setuptools are installed use:

git clone https://github.com/jopohl/urh/
cd urh
python setup.py install

And start the application by typing urh in a terminal.

Articles

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!

Screenshots

Get the data out of raw signals

Interpretation phase

Keep an overview even on complex protocols

Analysis phase

Record and send signals

Record

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

urh-2.8.6.tar.gz (3.0 MB view hashes)

Uploaded Source

Built Distributions

urh-2.8.6-cp38-cp38-manylinux2014_x86_64.whl (26.9 MB view hashes)

Uploaded CPython 3.8

urh-2.8.6-cp37-cp37m-win_amd64.whl (12.5 MB view hashes)

Uploaded CPython 3.7m Windows x86-64

urh-2.8.6-cp37-cp37m-win32.whl (10.4 MB view hashes)

Uploaded CPython 3.7m Windows x86

urh-2.8.6-cp37-cp37m-manylinux2014_x86_64.whl (26.3 MB view hashes)

Uploaded CPython 3.7m

urh-2.8.6-cp37-cp37m-macosx_10_13_x86_64.whl (3.4 MB view hashes)

Uploaded CPython 3.7m macOS 10.13+ x86-64

urh-2.8.6-cp36-cp36m-manylinux2014_x86_64.whl (26.3 MB view hashes)

Uploaded CPython 3.6m

urh-2.8.6-cp35-cp35m-manylinux2014_x86_64.whl (26.2 MB view hashes)

Uploaded CPython 3.5m

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page