urh README

The project's README from github.com/jopohl/urh. As one markdown file: README.md.

URH image

CI Code style: black 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 
@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

URH runs on Windows, Linux and macOS. See below for OS specific installation instructions.

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

Installation with pipx

URH is available on PyPi so you can install it, for example, with pipx: 

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

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 Images

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 13 when using the DMG available here.

With brew

URH is available as a homebrew formula so you can install it with

brew install urh

Running from source (OS-agnostic)

Without installation

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

git clone https://github.com/jopohl/urh/
cd urh/src/urh
PYTHONPATH=.. ./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: 

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

urh (jopohl/urh)

Searching Database…

12.6K ·GitHub
Urh
archived
Что это такое?URH (Universal Radio Hacker) — это набор инструментов для исследования беспроводных протоколов: он перехватывает радиосигналы с помощью SDR-оборудования, демодулирует их с автоматическим определением типа модуляции и помогает восстанавливать биты и байты, которые передаются по воздуху.
Это приложение с графическим интерфейсом или библиотека, которую я импортирую в код?Это самостоятельное настольное приложение с графическим интерфейсом на основе Qt, которое устанавливают и запускают как программу, а не импортируют как библиотеку.
Как мне установить URH на свою ОС?В Windows используйте официальный установщик; в Linux рекомендуемый способ — pipx (в комплекте поставляются предварительно скомпилированные нативные расширения), также можно использовать менеджер пакетов вашего дистрибутива или официальный образ Docker; в macOS используйте DMG-образ или установите через Homebrew. Также можно запустить его напрямую из исходного кода без установки.
Нужно ли мне настоящее SDR-оборудование, чтобы им пользоваться?Да, URH предназначен для работы с реальными Software Defined Radio, такими как HackRF, RTL-SDR, USRP, LimeSDR, AirSpy, bladeRF или SDRplay. В Linux перед установкой URH также нужны правила udev для доступа к USB без прав root и нативный пакет драйверов для вашего конкретного SDR.
Проект всё ещё активно поддерживается?Нет, репозиторий архивирован, то есть он больше не получает обновлений, исправлений ошибок или патчей совместимости для новых версий ОС или драйверов SDR.
Чем URH отличается от простого просмотра сырых сигналов в обычной SDR-программе?URH выходит за рамки отображения сигналов: он автоматически определяет параметры модуляции, декодирует сложные кодировки, например отбеливание данных CC1101, и позволяет вручную или автоматически восстанавливать поля протокола и типы сообщений из перехваченного трафика.
Могу ли я фаззить или воспроизводить перехваченные протоколы?Да, URH включает компонент фаззинга для протоколов без состояния и среду моделирования для построения атак с учётом состояния, так что вы можете записать сигнал, изменить его и отправить повторно.
Есть ли реальные примеры взломов, выполненных с помощью URH?В README приведены ссылки на разборы, например на реверс-инжиниринг беспроводных жалюзи, радиосигналов метеостанций, розеток с дистанционным управлением, а также на атаки на беспроводные клавиатуры и презентеры.
Может ли сообщество добавлять поддержку новых кодировок?Да, URH поддерживает пользовательские декодеры, а на вики проекта размещён список внешних декодеров, созданных сообществом.
What are similar projects?unleashed-firmware, esp-sdr, WireTapper, sdrmm, BLEhound, w1700k-sdr, vhs-decode, V3SP3R
Which topics is it in?sdr, wireless, radio, fuzzing, qt, protocol, iot, hacking, hardware, reverse-engineering, cybersecurity, gplv3
Creator
jopohl
Size
54 MB
Stars
12.6K
Updated
CommitDec 19Releasev2.10.0Dec 17
Age
10y
Commits · 90 Days