Skip to main content

Universal Radio Hacker: investigate wireless protocols like a boss

Project description

Universal Radio Hacker Blackhat Arsenal 2017 Blackhat Arsenal 2018

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

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 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 inject the data back into the system
  • simulation environment to perform stateful attacks

To get started, download the official userguide (PDF), watch the demonstration videos (YouTube) or check out the wiki for more information and supported devices. Scroll down this page to learn how to install URH on your system.

Want to stay in touch? Slack

If you find URH useful, please consider giving this repository a :star: or even donate via PayPal. We appreciate your support!

If you use URH in your research paper, please cite this WOOT'18 paper, or directly use the following BibTeX entry.

BibTeX entry for citing URH
@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 it's MSI 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

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.

Generic Installation with pip (Ubuntu/Debian)

URH you can also be installed with using python3 -m pip install urh. In case you are running Ubuntu or Debian read on for more specific instructions.

In order to use native device backends, make sure you install the -dev package for your desired SDRs, that is libairspy-dev, libhackrf-dev, librtlsdr-dev , libuhd-dev .

If your device does not have a -dev package, e.g. LimeSDR, you need to manually create a symlink to the .so, like this:

sudo ln -s /usr/lib/x86_64-linux-gnu/libLimeSuite.so.17.02.2 /usr/lib/x86_64-linux-gnu/libLimeSuite.so

before installing URH, using:

sudo apt-get update
sudo apt-get install python3-numpy python3-psutil python3-zmq python3-pyqt5 g++ libpython3-dev python3-pip cython3
sudo pip3 install urh

Docker Image

The official URH docker image is available here.

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

Updating with pip

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.

Updating with MSI

If you experience issues after updating URH using the .msi installer on Windows, please perform a full uninstallation. That is, uninstall URH via Windows and after that remove the installation folder (something like C:\Program Files\Universal Radio Hacker). Now, install the new version using the recent .msi .

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.0.tar.gz (2.9 MB view details)

Uploaded Source

Built Distributions

urh-2.8.0-cp37-cp37m-win_amd64.whl (12.5 MB view details)

Uploaded CPython 3.7m Windows x86-64

urh-2.8.0-cp37-cp37m-win32.whl (10.4 MB view details)

Uploaded CPython 3.7m Windows x86

urh-2.8.0-cp37-cp37m-macosx_10_13_x86_64.whl (3.4 MB view details)

Uploaded CPython 3.7m macOS 10.13+ x86-64

File details

Details for the file urh-2.8.0.tar.gz.

File metadata

  • Download URL: urh-2.8.0.tar.gz
  • Upload date:
  • Size: 2.9 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/2.0.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.7.4

File hashes

Hashes for urh-2.8.0.tar.gz
Algorithm Hash digest
SHA256 52124d348052d5921871cccb7d13d869b29c9d48b3da861191aea27976da1965
MD5 c5816932e83d9ae253ed1b8c1af39ed0
BLAKE2b-256 5334217173671fb93543e692f6e21374618aeaa367d054632a9fb7b4ed946d0b

See more details on using hashes here.

File details

Details for the file urh-2.8.0-cp37-cp37m-win_amd64.whl.

File metadata

  • Download URL: urh-2.8.0-cp37-cp37m-win_amd64.whl
  • Upload date:
  • Size: 12.5 MB
  • Tags: CPython 3.7m, Windows x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/2.0.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.4.0 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.7.4

File hashes

Hashes for urh-2.8.0-cp37-cp37m-win_amd64.whl
Algorithm Hash digest
SHA256 14c0bd3de1a2eaa8986530c1613a9b91101efee19d7ead0f995bd7322db136f0
MD5 58ea75ee3f927f355a4d95a659272137
BLAKE2b-256 1fbc96623acfea1ba9cccdbb3e2708f5c9bee3903a9ae4b9fc3038637a379ff6

See more details on using hashes here.

File details

Details for the file urh-2.8.0-cp37-cp37m-win32.whl.

File metadata

  • Download URL: urh-2.8.0-cp37-cp37m-win32.whl
  • Upload date:
  • Size: 10.4 MB
  • Tags: CPython 3.7m, Windows x86
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/2.0.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.4.0 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.7.4

File hashes

Hashes for urh-2.8.0-cp37-cp37m-win32.whl
Algorithm Hash digest
SHA256 44e2771cbbb028cddb28598532d717698bd1e0dc46c0c2bc218c8531d88564e5
MD5 645823d40742be5c8d2ca6a95c4fdc78
BLAKE2b-256 86dfa10c11bf2695ad027169fdf3e731fbf4bd77c4238f7a02e0300e8d99b3ae

See more details on using hashes here.

File details

Details for the file urh-2.8.0-cp37-cp37m-macosx_10_13_x86_64.whl.

File metadata

  • Download URL: urh-2.8.0-cp37-cp37m-macosx_10_13_x86_64.whl
  • Upload date:
  • Size: 3.4 MB
  • Tags: CPython 3.7m, macOS 10.13+ x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/2.0.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.4.0 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.7.4

File hashes

Hashes for urh-2.8.0-cp37-cp37m-macosx_10_13_x86_64.whl
Algorithm Hash digest
SHA256 6613dbcb50c1ea9c7fafbef74e671a82ce2ba40c9aac91836bc929a5965ccb29
MD5 e1aa0cfe9580d86141277092a2d98feb
BLAKE2b-256 e2d7ecf4ff7083cfc7d43af9bd2b954ebcfc68069a7e0888fe7647cbd2173662

See more details on using hashes here.

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