What is nexmon?

Nexmon is our C-based firmware patching framework for Broadcom/Cypress WiFi chips that enables you to write your own firmware patches, for example, to enable monitor mode with radiotap headers and frame injection.

Before we started to work on this repository, we developed patches for the Nexus 5 (with bcm4339 WiFi chip) in the bcm-public repository and those for the Raspberry Pi 3 (with ~~bcm43438~~bcm43430a1 WiFi chip) in the bcm-rpi3 repository. To remove the development overhead of maintaining multiple separate repositories, we decided to merge them in this repository and add support for some additional devices. In contrast to the former repositories, here, you can only build the firmware patch without drivers and kernels. The Raspberry Pi 3 makes an exception, as here it is always required to also build the driver.

Give Feedback

We setup a survey to learn about who uses Nexmon to which purpose and how we could improve Nexmon. We would be happy if every Nexmon user filled out this survey: https://nexmon.org/survey

WARNING

Our software may damage your hardware and may void your hardware’s warranty! You use our tools at your own risk and responsibility! If you don't like these terms, don't use nexmon!

Important changes

We started to collect usage statistics. In the file STATISTICS.md, you can find information on which data we collect and how you can opt-out of the statistics collection
Starting with commit 4f8697743dc46ffc37d87d960825367531baeef9 the brcmfmac driver for the RPi3 can now be used as a regular interface. You need to use nexutil to activate monitor mode (nexutil -m2 for monitor mode with radiotap headers), which will automtically adjust the interface type.
Starting with commit 184480edd6696392aae5f818f305f244606f2d17 you can choose different monitor mode options using nexutil. Use nexutil -m1 to activate monitor mode without radiotap headers, nexutil -m2 to activate it with radiotap headers. The numbers were chosen as non-Nexmon firmwares also support native monitor mode without radiotap headers by activating monitor mode with nexutil -m1.
Starting with commit 1bcfdc95b4395c2e8bdd962791ae20c4ba602f5b we changed the nexutil interface. Instead of calling nexutil -m true to activate monitor mode, you should now write nexutil -m1. To get the current monitor mode state execute nexutil -m instead of nexutil -n.

Supported Devices

The following devices are currently supported by our nexmon firmware patch.

WiFi Chip	Firmware Version	Used in	Operating System	M	RT	I	FP	UC	CT
bcm4330	5_90_100_41_sta	Samsung Galaxy S2	Cyanogenmod 13.0	X	X		X	X	O
bcm4335b0	6.30.171.1_sta	Samsung Galaxy S4	LineageOS 14.1	X	X	X		X	O
bcm4339	6_37_34_43	Nexus 5	Android 6 Stock	X	X	X	X	X	O
bcm43430a1*	7_45_41_26	Raspberry Pi 3 and Zero W	Raspbian 8	X	X	X	X	X	O
bcm43430a1*	7_45_41_46	Raspberry Pi 3 and Zero W	Raspbian Stretch	X	X	X	X	X	O
bcm4358	7_112_200_17_sta	Nexus 6P	Android 7 Stock	X	X		X	X	O
bcm4358	7_112_201_3_sta	Nexus 6P	Android 7.1.2 Stock	X	X		X	X	O
bcm4356	7_35_101_5_sta	Nexus 6	Android 7.1.2	X	X		X	X	O

* bcm43430a1 was wrongly labeled bcm43438 in the past.

Legend

M = Monitor Mode
RT = Monitor Mode with RadioTap headers
I = Frame Injection
FP = Flash Patching
UC = Ucode Compression
CT = c't Article Support (for consistent support, use our ct-artikel branch)

Steps to create your own firmware patches

Build patches for bcm4330, bcm4339 and bcm4358 using a x86 computer running Linux (e.g. Ubuntu 16.04)

Install some dependencies: sudo apt-get install git gawk qpdf adb flex bison

Only necessary for x86_64 systems, install i386 libs:

sudo dpkg --add-architecture i386
sudo apt-get update
sudo apt-get install libc6:i386 libncurses5:i386 libstdc++6:i386

Clone our repository: git clone https://github.com/seemoo-lab/nexmon.git
In the root directory of the repository: cd nexmon
- Setup the build environment: source setup_env.sh
- Compile some build tools and extract the ucode and flashpatches from the original firmware files: make
Go to the patches folder of your target device (e.g. bcm4339 for the Nexus 5): cd patches/bcm4339/6_37_34_43/nexmon/
- Compile a patched firmware: make
- Generate a backup of your original firmware file: make backup-firmware
- Install the patched firmware on your smartphone: make install-firmware (make sure your smartphone is connected to your machine beforehand)

Using the Monitor Mode patch

Install at least nexutil and libfakeioctl from our utilities. The easiest way to do this is by using this app: https://nexmon.org/app. But you can also build it from the source by executing make in the utilties folder (Note: you will need the Android NDK properly installed for this).
Connect to your Android phone using the ADB tools: adb shell
Make sure you are not connected to an access point
Use nexutil to enable monitor mode: nexutil -m2
At this point the monitor mode is active. There is no need to call airmon-ng.
Important: Most tools need a Radiotap interface to work properly. libfakeioctl emulates this type of interface for you, therefore, use LD_PRELOAD to load this library when you call the favourite tool (e.g. tcpdump or airodump-ng): LD_PRELOAD=libfakeioctl.so tcpdump -i wlan0
untested hint: Thanks to XDA member ruleh, there is a bcmdhd driver patch to activate native monitor mode, see: https://github.com/ruleh/misc/tree/master/monitor

Using nexutil over UDP on Nexus 5

To be able to communicate with the firmware without root priviledges, we created a UDP interface accessible through the libnexio, which is also used by nexutil. You first have to prove to the firmware that you generally have root priviledges by setting a securtiy cookie. Then you can use it for UDP based connections. Your wlan0 interface also needs an IP address in the 192.168.222.0/24 range or you have to change the default nexutil broadcast-ip:

Set the IP address of the wlan0 interface: ifconfig wlan0 192.168.222.1 netmask 255.255.255.0
Set the security cookie as root: nexutil -x<cookie (uint)>
Start a UDP connection for example to activate monitor mode: nexutil -X<cookie> -m1

Build patches for bcm43438bcm43430a1 on the RPI3/Zero W using Raspbian Stretch (recommended)

Note: We currently support Kernel Version 4.4 (depricated) and 4.9

Make sure the following commands are executed as root: sudo su
Upgrade your Raspbian installation: apt-get update && apt-get upgrade
Install the kernel headers to build the driver and some dependencies: sudo apt install raspberrypi-kernel-headers git libgmp3-dev gawk qpdf bison flex make
Clone our repository: git clone https://github.com/seemoo-lab/nexmon.git
Go into the root directory of our repository: cd nexmon
Check if /usr/lib/arm-linux-gnueabihf/libisl.so.10 exists, if not, compile it from source:
- cd buildtools/isl-0.10, ./configure, make, make install, ln -s /usr/local/lib/libisl.so /usr/lib/arm-linux-gnueabihf/libisl.so.10
Then you can setup the build environment for compiling firmware patches
- Setup the build environment: source setup_env.sh
- Compile some build tools and extract the ucode and flashpatches from the original firmware files: make
Go to the patches folder for the bcm43430a1 chipset: cd patches/bcm43430a1/7_45_41_46/nexmon/
- Compile a patched firmware: make
- Generate a backup of your original firmware file: make backup-firmware
- Install the patched firmware on your RPI3: make install-firmware
Install nexutil: from the root directory of our repository switch to the nexutil folder: cd utilities/nexutil/. Compile and install nexutil: make && make install.
Optional: remove wpa_supplicant for better control over the WiFi interface: apt-get remove wpasupplicant
Note: To connect to regular access points you have to execute nexutil -m0 first

Using the Monitor Mode patch

~~Our modified driver sets the interface in monitor mode as soon as the interface goes up: ifconfig wlan0 up~~
In the default setting the brcmfmac driver can be used regularly as a WiFi station with out firmware. To activate monitor mode, execute nexutil -m2.
At this point the monitor mode is active. There is no need to call airmon-ng.
The interface already set the Radiotap header, therefore, tools like tcpdump or airodump-ng can be used out of the box: tcpdump -i wlan0
Optional: To make the RPI3 load the modified driver after reboot:
- Find the path of the default driver at reboot: modinfo brcmfmac #the first line should be the full path
- Backup the original driver: mv "<PATH TO THE DRIVER>/brcmfmac.ko" "<PATH TO THE DRIVER>/brcmfmac.ko.orig"
- Copy the modified driver: cp /home/pi/nexmon/patches/bcm43430a1/7_45_41_46/nexmon/brcmfmac_kernel49/brcmfmac.ko "<PATH TO THE DRIVER>/"
- Probe all modules and generate new dependency: depmod -a
- The new driver should be loaded by default after reboot: reboot
- Note: With this setting, you can toggle between Monitor mode and Managed mode with: nexutil -m2 and nexutil -m0
- Note: It is possible to connect to an access point using our modified driver and firmware, just set the wireless interface in Managed mode.

How to build the utilities

To build the utilities such as nexmon or dhdutil for Android, you need to download the old NDK version 11c, extract it and export the environment variable NDK_ROOT pointing to the directory where you extracted the NDK files.

How to extract the ROM

The Wi-Fi firmware consists of a read-only part stored in the ROM of every Wi-Fi chip and another part that is loaded by the driver into the RAM. To analyze the whole firmware, one needs to extract the ROM. There are two options to do this. Either you write a firmware patch that simply copies the contents of the ROM to RAM and then you dump the RAM, or you directly dump the ROM after loading the regular firmware into the RAM. Even though, the second option is easier, it only works, if the ROM can be directly accessed by the driver, which is not always the case. Additionally, the firmware loaded into RAM can contain ROM patches that overlay the data stored in ROM. By dumping the ROM after loading the original RAM firmware, it contains flash patches. Hence, the ROM needs to be dumped again for every RAM firmware update to be consistent. As a conclusion, we prefer to dump the clean ROM after copying it to RAM.

Dumping the ROM directly

To dump the ROM directly, you need to know, where to find it and how large it is. On chips with Cortex-M3 it is usually at upper addresses such as 0x800000, while on chips with Cortex-R4 it is likely at 0x0. Run dhdutil to perform the dump:

dhdutil membytes -r 0x0 0xA0000 > rom.bin

Dumping a clean ROM after copying to RAM

For the BCM4339 and BCM4358, we created rom_extraction projects that load a firmware patch that copies ROM to RAM and them dumps it using dhdutil. To dump the ROM simply execute the following in the project directory:

make dump-rom

After ROM extraction, the rom.bin file will be copies to the corresponding firmwares subdirectory. To apply the flash patches of a specific RAM firmware version, enter its directory and execute:

make rom.bin

Structure of this repository

buildtools: Contains compilers and other tools to build the firmware
firmwares
- <chip version>
  - <firmware version>
    - <firmware file>: The original firmware that will be loaded into the RAM of the WiFi Chip
    - definitions.mk: Contains mainly firmware specific addresses
    - structs.h: Structures only valid for this firmware version
    - Makefile: Used to extract flashpatches and ucode
    - flashpatches.c (generated by Makefile): Contains flashpatches
    - ucode.bin (extracted by Makefile): Contains uncompressed Ucode
  - structs.common.h: Structures that are common between firmware versions
patches
- <chip version>
  - <firmware version>
    - nexmon
      - Makefile: Used to build the firmware
      - patch.ld: Linker file
      - src
        
        patch.c: General patches to the firmware
        
        injection.c: Code related to frame injection
        
        monitormode.c: Code related to monitor mode with radiotap headers
        
        ioctl.c: Handling of custom IOCTLs
        
        ...
      - obj (generated by Makefile): Object files created from C files
      - log (generated by Makefile): Logs written during compilation
      - gen (generated by Makefile): Files generated during the build process
        
        nexmon.pre (generated by gcc plugin): Extracted at-attributes and targetregion-pragmas
        
        nexmon.ld (generated from nexmon.pre): Linker file use to place patch code at defined addresses in the firmware
        
        nexmon.mk (generated from nexmon.pre): Make file used take code from patch.elf and place it into firmware
        
        flashpatches.ld (generated from nexmon.pre): Linker file that places flashpatches at target locations in firmware ROM
        
        flashpatches.mk (generated from nexmon.pre): Make file used to insert flashpatch config and data structures into firmware
        
        patch.elf (generated from object files and linker scripts): contains the newly compiled code placed at predefined addresses
  - common
    - wrapper.c: Wrappers for functions that already exist in the firmware
    - ucode_compression.c: tinflate based ucode decompression
    - radiotap.c: RadioTap header parser
    - helper.c: Helpful utility functions
  - include: Common include files
    - firmware_version.h: Definitions of chip and firmware versions
    - patcher.h: Macros use to perform patching for existing firmware code (e.g., BPatch patches a branch instruction)
    - capabilities.h: Allows to indicate capabilities (such as, monitor mode and frame injection)
    - nexioctl.h: Defines custom IOCTL numbers

Related projects

bcmon: Monitor Mode and Frame Injection for the bcm4329 and bcm4330
monmob: Monitor Mode and Frame Injection for the bcm4325, bcm4329 and bcm4330
imon: Penetration Testing for Apple devices with Broadcom WiFi Chip

Projects using nexmon

If you know more projects that use nexmon, let us know and we will add a link.

broadpwn: Remotely Compromising Android and IOS via a Bug in Broadcom's Wi-Fi Chipsets
Project Zero: Over The Air: Exploiting Broadcom's Wi-Fi Stack (Part 1)
Project Zero: Over The Air: Exploiting Broadcom's Wi-Fi Stack (Part 2)

Read our papers

D. Steinmetzer, D. Wegemer, M. Schulz, J. Widmer, M. Hollick. Compressive Millimeter-Wave Sector Selection in Off-the-Shelf IEEE 802.11ad Devices, Accepted for publication in Proceedings of the 13th International Conference on emerging Networking EXperiments and Technologies, CoNEXT 2017, December 2017.
M. Schulz, D. Wegemer, M. Hollick. Nexmon: Build Your Own Wi-Fi Testbeds With Low-Level MAC and PHY-Access Using Firmware Patches on Off-the-Shelf Mobile Devices, Accepted for publication in Proceedings of the 11th ACM International Workshop on Wireless Network Testbeds, Experimental Evaluation & Characterization (WiNTECH 2017), October 2017.
M. Schulz, F. Knapp, E. Deligeorgopoulos, D. Wegemer, F. Gringoli, M. Hollick. DEMO: Nexmon in Action: Advanced Applications Powered by the Nexmon Firmware Patching Framework, Accepted for publication in Proceedings of the 11th ACM International Workshop on Wireless Network Testbeds, Experimental Evaluation & Characterization, WiNTECH 2017, October 2017.
M. Schulz, F. Gringoli, D. Steinmetzer, M. Koch and M. Hollick. Massive Reactive Smartphone-Based Jamming using Arbitrary Waveforms and Adaptive Power Control. Proceedings of the 10th ACM Conference on Security and Privacy in Wireless and Mobile Networks (WiSec 2017), July 2017. pdf
M. Schulz, E. Deligeorgopoulos, M. Hollick and F. Gringoli. DEMO: Demonstrating Reactive Smartphone-Based Jamming. Proceedings of the 10th ACM Conference on Security and Privacy in Wireless and Mobile Networks (WiSec 2017), July 2017. pdf
M. Schulz. Nexmon - Wie man die eigene WLAN-Firmware hackt, c't 26/2016, S. 168, Heise Verlag, 2016.
M. Schulz, D. Wegemer, M. Hollick. DEMO: Using NexMon, the C-based WiFi firmware modification framework, Proceedings of the 9th ACM Conference on Security and Privacy in Wireless and Mobile Networks (WiSec 2016), July 2016. pdf
M. Schulz, D. Wegemer and M. Hollick. NexMon: A Cookbook for Firmware Modifications on Smartphones to Enable Monitor Mode, CoRR, vol. abs/1601.07077, December 2015. bibtex

Get references as bibtex file

Reference our project

Any use of this project which results in an academic publication or other publication which includes a bibliography should include a citation to the Nexmon project and probably one of our papers depending on the code you use. Find all references in our bibtex file. Here is the reference for the project only:

@electronic{nexmon:project,
	author = {Schulz, Matthias and Wegemer, Daniel and Hollick, Matthias},
	title = {Nexmon: The C-based Firmware Patching Framework},
	url = {https://nexmon.org},
	year = {2017}
}

jayece09/nexmon

What is nexmon?

Give Feedback

WARNING

Important changes

Supported Devices

Legend

Steps to create your own firmware patches

Build patches for bcm4330, bcm4339 and bcm4358 using a x86 computer running Linux (e.g. Ubuntu 16.04)

Using the Monitor Mode patch

Using nexutil over UDP on Nexus 5

Build patches for bcm43438bcm43430a1 on the RPI3/Zero W using Raspbian Stretch (recommended)

Using the Monitor Mode patch

How to build the utilities

How to extract the ROM

Dumping the ROM directly

Dumping a clean ROM after copying to RAM

Structure of this repository

Related projects

Projects using nexmon

Read our papers

Reference our project

Contact

Powered By

Secure Mobile Networking Lab (SEEMOO)

Networked Infrastructureless Cooperation for Emergency Response (NICER)

Multi-Mechanisms Adaptation for the Future Internet (MAKI)

Technische Universität Darmstadt