Mirage documentation
====================

Presentation
------------

.. image:: logo.png
    :align: center

Mirage is a powerful and modular framework dedicated to the security analysis of wireless communications. It currently provides :

  * multiple **lightweight and hackable wireless protocol stacks** (e.g. Bluetooth Low Energy, Enhanced ShockBurst, WiFi, Zigbee ...)
  * multiple **highly customizable offensive modules** (e.g. Man-in-the-Middle, sniffing, jamming, hijacking, cloning ...)
  * mutiple **modules dedicated to information gathering** (e.g. applicative layers dumping, scanning ...)
  * mutiple **experimental offensive modules based on InjectaBLE attack** (e.g. Bluetooth Low Energy injection, Slave and Master hijacking, MiTM ...)
  * a **chaining operator** allowing to easily combine attack modules in order to **build complex attack workflows**
  * support of **multiple devices**, such as HCI devices, Crazy Radio PA, RZUSBStick, BTLEJack, Nordic, Sniffle, ButteRFly and Ubertooth sniffers
  * an **user-friendly development environment** allowing to easily **write new modules** or **customize existing ones**
  * an experimental **Software defined radio** architecture, allowing to sniff and inject packets using HackRF One


.. note::

	Mirage is greatly inspired by the amazing work of the following security researchers :

	  * `Damien Cauquil (virtualabs) <http://www.virtualabs.fr/>`_: `BTLEJuice <https://github.com/DigitalSecurity/btlejuice>`_, `BTLEJack <https://github.com/virtualabs/btlejack>`_, `RadioBit <https://github.com/virtualabs/radiobit>`_
	  * `Mike Ryan <https://lacklustre.net/>`_: `PyBT <https://github.com/mikeryan/PyBT>`_, `crackle <https://github.com/mikeryan/crackle>`_
	  * `Slawomir Jasek <http://smartlockpicking.com/>`_: `GATTacker <https://github.com/securing/gattacker>`_
	  * `Marc Newlin <https://github.com/marcnewlin>`_: `MouseJack <https://github.com/BastilleResearch/mousejack/>`_
	  * `Joshua Wright <https://www.willhackforsushi.com/>`_: `Killerbee <https://github.com/riverloopsec/killerbee>`_
	  * `GreatScottGadgets <https://greatscottgadgets.com/>`_ and `the contributors <https://github.com/greatscottgadgets/ubertooth#contributors>`_ of the `Ubertooth project <https://github.com/greatscottgadgets/ubertooth>`_

Getting started
----------------
.. toctree::
   install
   overview

Mirage in a nutshell
---------------------
.. toctree::
   cli
   direct
   modules
   chaining_modules
   configuration_file
   devices
   emittersreceivers
   scenarios

Tutorials
---------
.. toctree::
   injectable
   
Supported protocols
--------------------
.. toctree::
   blestack
   esbstack
   mosartstack
   wifistack
   zigbeestack
   irstack

List of modules
----------------
.. toctree::
   blemodules
   esbmodules
   mosartmodules
   wifimodules
   zigbeemodules
   irmodules

API
---
.. toctree::
   mirage.libs
   mirage.core