Mirage documentation¶
Presentation¶

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 :
Getting started¶
Mirage in a nutshell¶
- Command-line Interface
- Direct execution
- Modules
- Chaining operator
- Configuration file
- Supported Devices
- Emitters and Receivers
- Scenarios
Tutorials¶
Supported protocols¶
List of modules¶
- List of Bluetooth Low Energy Modules
- List of Enhanced ShockBurst Modules
- List of Mosart Modules
- List of 802.11 Modules
- List of Zigbee Modules
- List of Infrared Radiations Modules
API¶
- mirage.libs package
- Subpackages
- mirage.libs.ble_utils package
- Submodules
- mirage.libs.ble_utils.adb module
- mirage.libs.ble_utils.hcidump module
- mirage.libs.ble_utils.pcap module
- mirage.libs.ble_utils.btlejack module
- mirage.libs.ble_utils.ubertooth module
- mirage.libs.ble_utils.nrfsniffer module
- mirage.libs.ble_utils.sniffle module
- mirage.libs.ble_utils.butterfly module
- mirage.libs.ble_utils.hackrf module
- mirage.libs.ble_utils.decoders module
- mirage.libs.ble_utils.encoders module
- mirage.libs.ble_utils.crypto module
- mirage.libs.ble_utils.att_server module
- mirage.libs.ble_utils.dissectors module
- mirage.libs.ble_utils.helpers module
- mirage.libs.ble_utils.packets module
- mirage.libs.ble_utils.scapy_hci_layers module
- mirage.libs.ble_utils.scapy_hci_layers module
- mirage.libs.ble_utils.scapy_btlejack_layers module
- mirage.libs.ble_utils.scapy_link_layers module
- mirage.libs.bt_utils package
- Submodules
- mirage.libs.bt_utils.assigned_numbers module
- mirage.libs.bt_utils.constants module
- mirage.libs.bt_utils.hciconfig module
- mirage.libs.bt_utils.packets module
- mirage.libs.bt_utils.scapy_layers module
- mirage.libs.bt_utils.scapy_ubertooth_layers module
- mirage.libs.bt_utils.scapy_vendor_specific module
- mirage.libs.bt_utils.ubertooth module
- Module contents
- mirage.libs.wifi_utils package
- mirage.libs.esb_utils package
- mirage.libs.mosart_utils package
- Submodules
- mirage.libs.mosart_utils.rfstorm module
- mirage.libs.mosart_utils.dissectors module
- mirage.libs.mosart_utils.constants module
- mirage.libs.mosart_utils.pcap module
- mirage.libs.mosart_utils.helpers module
- mirage.libs.mosart_utils.keyboard_codes module
- mirage.libs.mosart_utils.packets module
- mirage.libs.mosart_utils.scapy_mosart_layers module
- mirage.libs.zigbee_utils package
- Submodules
- mirage.libs.zigbee_utils.rzusbstick module
- mirage.libs.zigbee_utils.hackrf module
- mirage.libs.zigbee_utils.encoders module
- mirage.libs.zigbee_utils.decoders module
- mirage.libs.zigbee_utils.constants module
- mirage.libs.zigbee_utils.pcap module
- mirage.libs.zigbee_utils.helpers module
- mirage.libs.zigbee_utils.packets module
- mirage.libs.zigbee_utils.scapy_xbee_layers module
- mirage.libs.ir_utils package
- mirage.libs.wireless_utils package
- Submodules
- mirage.libs.wireless_utils.callbacks module
- mirage.libs.wireless_utils.device module
- mirage.libs.wireless_utils.packetQueue module
- mirage.libs.wireless_utils.packets module
- mirage.libs.wireless_utils.butterfly module
- mirage.libs.wireless_utils.pcapDevice module
- mirage.libs.wireless_utils.scapy_butterfly_layers module
- Module contents
- mirage.libs.common package
- Subpackages
- mirage.libs.common.sdr package
- Submodules
- mirage.libs.common.sdr.hardware module
- mirage.libs.common.sdr.sinks module
- mirage.libs.common.sdr.sources module
- mirage.libs.common.sdr.demodulators module
- mirage.libs.common.sdr.modulators module
- mirage.libs.common.sdr.decoders module
- mirage.libs.common.sdr.encoders module
- mirage.libs.common.sdr.pipeline module
- mirage.libs.common.sdr.hackrf_definitions
- mirage.libs.common.sdr package
- Submodules
- mirage.libs.common.hid module
- mirage.libs.common.parsers module
- Subpackages
- mirage.libs.ble_utils package
- Submodules
- mirage.libs.ble module
- mirage.libs.bt module
- mirage.libs.wifi module
- mirage.libs.esb module
- mirage.libs.mosart module
- mirage.libs.zigbee module
- mirage.libs.ir module
- mirage.libs.io module
- mirage.libs.utils module
- mirage.libs.wireless module
- Subpackages
- mirage.core package