Universal Radio Hacker: investigate wireless protocols like a boss
Project description
# Universal Radio Hacker [![Blackhat Arsenal 2017](https://rawgit.com/toolswatch/badges/master/arsenal/usa/2017.svg)](http://www.toolswatch.org/2017/06/the-black-hat-arsenal-usa-2017-phenomenal-line-up-announced/)
| Tests Linux/OSX | Tests Windows | Test Coverage | Latest Release |
| ------------- | ------------- | ------------- | -------- |
|[![Build Status](https://travis-ci.org/jopohl/urh.svg?branch=master)](https://travis-ci.org/jopohl/urh) | [![Build status](https://ci.appveyor.com/api/projects/status/8gxwx98ytrl5y3kt/branch/master?svg=true)](https://ci.appveyor.com/project/jopohl/urh/branch/master) | [![Coverage Status](https://coveralls.io/repos/github/jopohl/urh/badge.svg?branch=master)](https://coveralls.io/github/jopohl/urh?branch=master) | [![PyPI version](https://badge.fury.io/py/urh.svg)](https://badge.fury.io/py/urh) |
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
* __fuzzing component__ to find security leaks
* __modulation support__ to inject the data back into the system
To get started, download the [official userguide (PDF)](https://github.com/jopohl/urh/raw/master/data/userguide.pdf), watch the [demonstration videos (YouTube)](https://www.youtube.com/watch?v=kuubkTDAxwA)
or check out the [wiki](https://github.com/jopohl/urh/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](https://img.shields.io/badge/chat-on%20slack-blue.svg)](https://join.slack.com/t/stralsundsecurity/shared_invite/enQtMjEwOTIxNzMzODc3LWU4ZWIzMTQ3NDAyNjkzODBhZTJiZDNmN2U0MTA4ZTM1MjhhNTNiYTc4YzQ5MDk2NjU5YzMxOWJmMDQyZDczYjg)
If you find URH useful, please consider giving this repository a :star: or even [donate via PayPal](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=6WDFF59DL56Z2). We appreciate your support!
## 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:
- [Linux](#linux)
- [Via Package Manager](#via-package-manager)
- [Generic way with pip (Ubuntu/Debian)](#generic-way-with-pip-ubuntudebian)
- [Windows](#windows)
- [MSI Installer](#msi-installer)
- [Pip](#pip)
- [Mac OS X](#mac-os-x)
- [Updating your installation](#update-your-installation)
- [Updating with Pip](#updating-with-pip)
- [Updating with MSI](#updating-with-msi)
- [Running from source](#running-from-source)
### Linux
#### Via Package Manager
For the following linux distributions you can install URH using your package manager.
| Distribution | Install with |
| ------------- | ------------- |
| Arch Linux | ``` yaourt -S urh ``` |
| Gentoo / Pentoo | ``` emerge -av urh ``` |
| Fedora 25+ | ``` dnf install urh ``` |
| openSUSE | ``` zypper install urh ``` |
#### Generic way with pip (Ubuntu/Debian)
URH you can also be installed with __pip__ using ```pip3 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:
```bash
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:
```bash
sudo apt-get update
sudo apt-get install python3-numpy python3-psutil python3-zmq python3-pyqt5 g++ libpython3-dev python3-pip
sudo pip3 install urh
```
### Windows
#### MSI Installer
The easiest way to install URH on Windows is to use the ```.msi``` installer available [here](https://github.com/jopohl/urh/releases).
It is recommended to use the __64 bit version__ of URH because native device support is not available on 32 bit windows.
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).
#### Pip
If you run Python 3.4 on Windows you need to install [Visual C++ Build Tools 2015](http://landinghub.visualstudio.com/visual-cpp-build-tools) first.
__It is recommended to use Python 3.5 or later on Windows, so no C++ compiler needs to be installed.__
1. Install [Python 3 for Windows](https://www.python.org/downloads/windows/). Choose a __64 Bit__ Python version for native device support.
2. In a terminal, type: ``` pip install urh ```.
3. Type ``` urh ``` in a terminal or search for ``` urh ``` in search bar to start the application.
### Mac OS X
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
#### 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:
```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 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:
```bash
git clone https://github.com/jopohl/urh/
cd urh
python setup.py install
```
And start the application by typing ``` urh ``` in a terminal.
### External decodings
See [wiki](https://github.com/jopohl/urh/wiki/External-decodings) for a list of external decodings provided by our community! Thanks for that!
### Screenshots
#### Get the data out of raw signals
![Interpretation phase](http://i.imgur.com/Wy17Zv3.png)
#### Keep an overview even on complex protocols
![Analysis phase](http://i.imgur.com/ubAL3pE.png)
#### Record and send signals
![Record](http://i.imgur.com/BfQpg23.png)
| Tests Linux/OSX | Tests Windows | Test Coverage | Latest Release |
| ------------- | ------------- | ------------- | -------- |
|[![Build Status](https://travis-ci.org/jopohl/urh.svg?branch=master)](https://travis-ci.org/jopohl/urh) | [![Build status](https://ci.appveyor.com/api/projects/status/8gxwx98ytrl5y3kt/branch/master?svg=true)](https://ci.appveyor.com/project/jopohl/urh/branch/master) | [![Coverage Status](https://coveralls.io/repos/github/jopohl/urh/badge.svg?branch=master)](https://coveralls.io/github/jopohl/urh?branch=master) | [![PyPI version](https://badge.fury.io/py/urh.svg)](https://badge.fury.io/py/urh) |
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
* __fuzzing component__ to find security leaks
* __modulation support__ to inject the data back into the system
To get started, download the [official userguide (PDF)](https://github.com/jopohl/urh/raw/master/data/userguide.pdf), watch the [demonstration videos (YouTube)](https://www.youtube.com/watch?v=kuubkTDAxwA)
or check out the [wiki](https://github.com/jopohl/urh/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](https://img.shields.io/badge/chat-on%20slack-blue.svg)](https://join.slack.com/t/stralsundsecurity/shared_invite/enQtMjEwOTIxNzMzODc3LWU4ZWIzMTQ3NDAyNjkzODBhZTJiZDNmN2U0MTA4ZTM1MjhhNTNiYTc4YzQ5MDk2NjU5YzMxOWJmMDQyZDczYjg)
If you find URH useful, please consider giving this repository a :star: or even [donate via PayPal](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=6WDFF59DL56Z2). We appreciate your support!
## 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:
- [Linux](#linux)
- [Via Package Manager](#via-package-manager)
- [Generic way with pip (Ubuntu/Debian)](#generic-way-with-pip-ubuntudebian)
- [Windows](#windows)
- [MSI Installer](#msi-installer)
- [Pip](#pip)
- [Mac OS X](#mac-os-x)
- [Updating your installation](#update-your-installation)
- [Updating with Pip](#updating-with-pip)
- [Updating with MSI](#updating-with-msi)
- [Running from source](#running-from-source)
### Linux
#### Via Package Manager
For the following linux distributions you can install URH using your package manager.
| Distribution | Install with |
| ------------- | ------------- |
| Arch Linux | ``` yaourt -S urh ``` |
| Gentoo / Pentoo | ``` emerge -av urh ``` |
| Fedora 25+ | ``` dnf install urh ``` |
| openSUSE | ``` zypper install urh ``` |
#### Generic way with pip (Ubuntu/Debian)
URH you can also be installed with __pip__ using ```pip3 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:
```bash
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:
```bash
sudo apt-get update
sudo apt-get install python3-numpy python3-psutil python3-zmq python3-pyqt5 g++ libpython3-dev python3-pip
sudo pip3 install urh
```
### Windows
#### MSI Installer
The easiest way to install URH on Windows is to use the ```.msi``` installer available [here](https://github.com/jopohl/urh/releases).
It is recommended to use the __64 bit version__ of URH because native device support is not available on 32 bit windows.
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).
#### Pip
If you run Python 3.4 on Windows you need to install [Visual C++ Build Tools 2015](http://landinghub.visualstudio.com/visual-cpp-build-tools) first.
__It is recommended to use Python 3.5 or later on Windows, so no C++ compiler needs to be installed.__
1. Install [Python 3 for Windows](https://www.python.org/downloads/windows/). Choose a __64 Bit__ Python version for native device support.
2. In a terminal, type: ``` pip install urh ```.
3. Type ``` urh ``` in a terminal or search for ``` urh ``` in search bar to start the application.
### Mac OS X
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
#### 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:
```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 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:
```bash
git clone https://github.com/jopohl/urh/
cd urh
python setup.py install
```
And start the application by typing ``` urh ``` in a terminal.
### External decodings
See [wiki](https://github.com/jopohl/urh/wiki/External-decodings) for a list of external decodings provided by our community! Thanks for that!
### Screenshots
#### Get the data out of raw signals
![Interpretation phase](http://i.imgur.com/Wy17Zv3.png)
#### Keep an overview even on complex protocols
![Analysis phase](http://i.imgur.com/ubAL3pE.png)
#### Record and send signals
![Record](http://i.imgur.com/BfQpg23.png)
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.1.1.tar.gz
(2.9 MB
view hashes)
Built Distributions
urh-2.1.1-cp36-cp36m-win32.whl
(10.0 MB
view hashes)
urh-2.1.1-cp35-cp35m-win32.whl
(10.0 MB
view hashes)
Close
Hashes for urh-2.1.1-cp36-cp36m-win_amd64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7c92526e23b9a4423151dc52e857bbaab81976548462f23f3f1c840db03064b2 |
|
MD5 | 943e12711d4d59fa4bfda6396d7c4190 |
|
BLAKE2b-256 | a576c332b8c05d275deabd405028982c47f03d9ca684bf21fca0b5d39090ef7a |
Close
Hashes for urh-2.1.1-cp35-cp35m-win_amd64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ea5dfc0e2d3536c9eca86e4c41de5e0e2224c11b14301f5b3fd0ef92bba22150 |
|
MD5 | 238cfb47222ee7e2836e3cc154666e3e |
|
BLAKE2b-256 | 96df61048dbee95412084d48170480e5d2d1d266048eb9e400c74b9ce05ead62 |