Metadata-Version: 1.1
Name: urh
Version: 1.8.17
Summary: Universal Radio Hacker: investigate wireless protocols like a boss
Home-page: https://github.com/jopohl/urh
Author: Johannes Pohl
Author-email: Johannes.Pohl90@gmail.com
License: GNU General Public License (GPL)
Download-URL: https://github.com/jopohl/urh/tarball/v1.8.17
Description-Content-Type: UNKNOWN
Description: Universal Radio Hacker
        ======================
        
        |Linux Build Status| |Windows Build status| |OSX Build Status| |Code
        Climate| |PyPI version|
        
        |Blackhat Arsenal 2017| |Donate|
        
        The Universal Radio Hacker 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
        
        Check out the `wiki <https://github.com/jopohl/urh/wiki>`__ for more
        information and supported devices.
        
        Like to see things in action? Watch URH on YouTube!
        
        |Youtube Image|
        
        Want to stay in touch? Join our `Slack
        Channel <https://join.slack.com/t/stralsundsecurity/shared_invite/MjEwOTIxNzMzODc3LTE0OTk3NTM3NzUtNDU0YWJkNGM5Yw>`__!
        
        Installation
        ============
        
        Universal Radio Hacker can be installed via *pip* or using the *package
        manager* of your distribution (if included). Furthermore, you can
        `install urh from source <#installing-from-source>`__ or run it `without
        installation <#without-installation>`__ directly from source. Below you
        find more specific installation instructions for: - Linux Distributions:
        - `Arch Linux <#arch-linux>`__ - `Ubuntu/Debian <#ubuntudebian>`__ -
        `Gentoo/Pentoo <#gentoopentoo>`__ - `Fedora 25+ <#fedora-25>`__ -
        `openSUSE <#opensuse>`__ - `Windows <#windows>`__ - `Mac OS
        X <#mac-os-x>`__
        
        Dependencies
        ------------
        
        +---------------+-------------------------------------------------------------+
        | Required      | Optional                                                    |
        +===============+=============================================================+
        | Python 3.4+   | librtlsdr (for native RTL-SDR support)                      |
        +---------------+-------------------------------------------------------------+
        | python-numpy  | libhackrf (for native HackRF support)                       |
        +---------------+-------------------------------------------------------------+
        | python-psutil | libairspy (for native AirSPy support)                       |
        +---------------+-------------------------------------------------------------+
        | python-zmq    | liblimesdr (for native LimeSDR support)                     |
        +---------------+-------------------------------------------------------------+
        | PyQt5         | libuhd (for native USRP suppport)                           |
        +---------------+-------------------------------------------------------------+
        | C++ Compiler  | rfcat (for RfCat plugin to send e.g. with YardStick One)    |
        +---------------+-------------------------------------------------------------+
        |               | gnuradio / gnuradio-osmosdr (for GNU Radio device backends) |
        +---------------+-------------------------------------------------------------+
        
        Installation examples
        ---------------------
        
        Arch Linux
        ~~~~~~~~~~
        
        .. code:: bash
        
            yaourt -S urh
        
        Ubuntu/Debian
        ~~~~~~~~~~~~~
        
        If you want to use native device backends, make sure you install the
        **-dev** package for your desired SDRs, that is: - AirSpy:
        ``libairspy-dev`` - HackRF: ``libhackrf-dev`` - RTL-SDR:
        ``librtlsdr-dev`` - USRP: ``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:
        
        .. code:: 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:
        
        .. code:: 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
        
        Gentoo/Pentoo
        ~~~~~~~~~~~~~
        
        .. code:: bash
        
            emerge -av urh
        
        Fedora 25+
        ~~~~~~~~~~
        
        .. code:: bash
        
            dnf install urh
        
        openSUSE
        ~~~~~~~~
        
        If you use Tumbleweed (Rolling Release), you can install URH directly
        with
        
        .. code:: bash
        
            sudo zypper install urh
        
        If you use Leap 42.2+ you need to add the ``hardware:sdr`` repo before:
        
        .. code:: bash
        
            sudo zypper addrepo -f https://download.opensuse.org/repositories/hardware:/sdr/openSUSE_Leap_42.3/hardware:sdr.repo
            sudo zypper 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/>`__.
        
        -  Make sure you tick the *Add Python to PATH* checkbox on first page in
           Python installer.
        -  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
        ------------------------
        
        If you installed URH via pip you can keep it up to date with
        
        .. code:: bash
        
            pip3 install --upgrade urh
        
        If this shouldn’t work you can try:
        
        .. code:: bash
        
            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:
        
        .. code:: 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:
        
        .. code:: 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!
        
        .. |Linux Build Status| image:: https://img.shields.io/travis/jopohl/urh/master.svg?label=Linux
           :target: https://travis-ci.org/jopohl/urh
        .. |Windows Build status| image:: https://img.shields.io/appveyor/ci/jopohl/urh/master.svg?label=Windows
           :target: https://ci.appveyor.com/project/jopohl/urh/branch/master
        .. |OSX Build Status| image:: https://img.shields.io/circleci/project/github/jopohl/urh/master.svg?label=OSX
           :target: https://circleci.com/gh/jopohl/urh/tree/master
        .. |Code Climate| image:: https://codeclimate.com/github/jopohl/urh/badges/gpa.svg
           :target: https://codeclimate.com/github/jopohl/urh
        .. |PyPI version| image:: https://badge.fury.io/py/urh.svg
           :target: https://pypi.python.org/pypi/urh
        .. |Blackhat Arsenal 2017| image:: https://rawgit.com/toolswatch/badges/master/arsenal/2017.svg
           :target: http://www.toolswatch.org/2017/06/the-black-hat-arsenal-usa-2017-phenomenal-line-up-announced/
        .. |Donate| image:: https://img.shields.io/badge/Donate-PayPal-green.svg
           :target: https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=6WDFF59DL56Z2
        .. |Youtube Image| image:: http://i.imgur.com/5HGzP2T.png
           :target: https://www.youtube.com/watch?v=kuubkTDAxwA
        
Platform: UNKNOWN
