Metadata-Version: 1.1
Name: urh
Version: 1.9.2
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.9.2
Description-Content-Type: UNKNOWN
Description: Universal Radio Hacker
        ======================
        
        |PyPI version| |Coverage Status| |Slack| |Blackhat Arsenal 2017|
        |Donate|
        
        +----------------+----------------+------------+
        | Linux          | Windows        | OSX        |
        +================+================+============+
        | |Build Status| | |Build status| | |CircleCI| |
        +----------------+----------------+------------+
        
        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
        
        To get started, you can \* download the `official userguide
        (PDF) <https://github.com/jopohl/urh/raw/master/data/userguide.pdf>`__
        \* watch the **demonstration videos** `on
        YouTube <https://www.youtube.com/watch?v=kuubkTDAxwA>`__ \* check out
        the `wiki <https://github.com/jopohl/urh/wiki>`__ for more information
        and supported devices.
        
        Want to stay in touch? Chat with us on
        `Slack <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 <#linux>`__ -
        `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  | libsdrplay (for native SDRplay support)                     |
        +---------------+-------------------------------------------------------------+
        |               | rfcat (for RfCat plugin to send e.g. with YardStick One)    |
        +---------------+-------------------------------------------------------------+
        |               | gnuradio / gnuradio-osmosdr (for GNU Radio device backends) |
        +---------------+-------------------------------------------------------------+
        
        Linux
        ~~~~~
        
        Via Package Manager
        ^^^^^^^^^^^^^^^^^^^
        
        If you run any of 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
        ^^^^^^^^^^^^^^^^^^^^
        
        If your distribution does not provide a package for URH you can install
        it using ``pip3 install urh``. Below you find more detailed instructions
        for Ubuntu/Debian.
        
        Ubuntu/Debian
        '''''''''''''
        
        If you want 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:
        
        .. 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
        
        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
        ~~~~~~~~~~~~~~~~~~~~~~~~
        
        .. _pip-1:
        
        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``.
        
        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:
        
        .. 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!
        
        .. |PyPI version| image:: https://badge.fury.io/py/urh.svg
           :target: https://pypi.python.org/pypi/urh
        .. |Coverage Status| image:: https://coveralls.io/repos/github/jopohl/urh/badge.svg?branch=master
           :target: https://coveralls.io/github/jopohl/urh?branch=master
        .. |Slack| image:: https://img.shields.io/badge/chat-on%20slack-blue.svg
           :target: https://join.slack.com/t/stralsundsecurity/shared_invite/enQtMjEwOTIxNzMzODc3LWU4ZWIzMTQ3NDAyNjkzODBhZTJiZDNmN2U0MTA4ZTM1MjhhNTNiYTc4YzQ5MDk2NjU5YzMxOWJmMDQyZDczYjg
        .. |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
        .. |Build Status| image:: https://travis-ci.org/jopohl/urh.svg?branch=master
           :target: https://travis-ci.org/jopohl/urh
        .. |Build status| image:: https://ci.appveyor.com/api/projects/status/8gxwx98ytrl5y3kt/branch/master?svg=true
           :target: https://ci.appveyor.com/project/jopohl/urh/branch/master
        .. |CircleCI| image:: https://circleci.com/gh/jopohl/urh/tree/master.svg?style=svg
           :target: https://circleci.com/gh/jopohl/urh/tree/master
        
Platform: UNKNOWN
