data_available() and data_available_fast() are how the device notices that the host has asked a running command to stop. They branch on USB and on WITH_FPC_USART_HOST, and never learned about the Proxmark5 BWM. A PM5 with the wireless module builds PLATFORM=PM5 PLATFORM_EXTRAS=BWM, which defines WITH_BWM_FORWARD. BTADDON errors out on PM5 and BWM errors out on anything else (common_arm/Makefile.hal), so WITH_FPC_USART_HOST is never defined on that build and both functions compile down to a USB-only check. Commands still arrive, because receive_ng() does poll the module (armsrc/cmd.c). What was blind was the abort path: CMD_BREAK_LOOP is never observed over BLE or WiFi, so every loop whose only exit is this check runs until the button is pressed. That is 75 call sites across 26 files in armsrc/, including the sniff, simulate and reader loops, so in practice a wireless session cannot be interrupted at all. ReaderHitag() is the worst case: with no tag on the antenna it has no other exit, so `lf search` alone leaves the device answering nothing. This is reachable with upstream tooling only: client/src/uart/ble_posix.c is the native BLE transport, selected with `-p ble:<address-or-name>`, and doc/md/PM5_Start_Here/PM5-BWM-USAGE.md documents both that and `-p tcp:<host>:<port>` over the module's WiFi. Both share the same inbound de-framer, so both are affected. Folded into the existing preprocessor chain as an #elif, mirroring receive_ng(), since the two transports are mutually exclusive by build. USB is still tested first, so the module is only polled when USB has nothing, exactly as the FPC branch behaves. bwm_fwd_rxdata_available() is the same call receive_ng() already uses. When the de-frame FIFO is empty it costs a flag test and one DMA counter read (bwm_uart_rx_available()); it only walks bytes when bytes have actually arrived, and those bytes are the abort. That mirrors the FPC branch, where usart_rxdata_available() already calls usart_rx_poll() from these same two functions. data_available_fast()'s only caller is the ReadLF_realtime() sampling loop, which reaches it once per 64 saved samples; it is included here so the two functions cannot drift apart again, which is how this bug arose. Object code is byte-identical on every platform that does not define WITH_BWM_FORWARD. Built PLATFORM=PM3RDV4, PM3RDV4 with BTADDON, PM5 without BWM and PM5 with BWM; only the last one changes: PM3RDV4 74f7f7a1... -> 74f7f7a1... identical PM3RDV4 BTADDON f94c31de... -> f94c31de... identical PM5 e3f0a203... -> e3f0a203... identical PM5 BWM e3f0a203... -> efbba2f0... changed Passes `make style` unmodified. Verified on a Proxmark5 with the BWM fitted, over BLE, with the stock client. Before, one command left the device deaf for good: [fpc|tcp] pm5 --> hw ping [+] Ping response received in 111 ms and content ( ok ) [fpc|tcp] pm5 --> lf hitag read --ht2 --pwd -k 4D494B52 [!] timeout while waiting for reply [fpc|tcp] pm5 --> hw ping [!] Ping response timeout [fpc|tcp] pm5 --> hw ping [!] Ping response timeout After, the same sequence on the same device: [fpc|tcp] pm5 --> hw ping [+] Ping response received in 107 ms and content ( ok ) [fpc|tcp] pm5 --> lf hitag read --ht2 --pwd -k 4D494B52 [!] timeout while waiting for reply [fpc|tcp] pm5 --> hw ping [+] Ping response received in 102 ms and content ( ok ) [fpc|tcp] pm5 --> hw ping [+] Ping response received in 85 ms and content ( ok ) A USB command recovers a device stuck this way, which is why the bug is easy to miss on a bench with a cable attached: after the failing sequence above, `hw ping` over USB answered in 1 ms and the wireless link resumed.
Iceman Fork - Proxmark
The Proxmark is the swiss-army tool of RFID, allowing for interactions with the vast majority of RFID tags on a global scale. Originally built by Jonathan Westhues, the device is now the goto tool for RFID Analysis for the enthusiast.
Iceman repository is considered to be the pinnacle of features and functionality, enabling a huge range of extremely useful and convenient commands and Python/LUA scripts to automate chip identification, penetration testing, and programming.
| Latest Release | Coverity | Contributors |
|---|---|---|
| Actions OSX CI | Actions Ubuntu CI | Actions Windows CI |
|---|---|---|
Table of Contents
- Iceman Fork - Proxmark
- Table of Contents
- PROXMARK3 INSTALLATION AND OVERVIEW
- How to build?
- What has changed?
- Development
PROXMARK3 INSTALLATION AND OVERVIEW
Notes / helpful documents
How to build?
Proxmark5
The last hardware generation is called Proxmark5. It has
- MCU: AT32F435, a 288 MHz Artery Cortex-M4
- Gowin FPGA
- TypeC Extended Port (CEP)
- BLE / Wifi / Battery Addon, via a ESp32c2
- Swappable antennas (LF, HF, UHF)
- 125, 134, 250, 375, 500 KHz Low Frequency Antenna (LF)
- 13.56 MHz High Frequency Antenna (HF)
- as a addon: 860-960 MHz Ultra High Frequency Antenna (UHF), ** not developed yet **
At the moment, Proxmark5-specific instructions are all grouped in a single Getting Started guide. Read it to build, flash and run your Proxmark5 device. See the instruction links in the tables above to get the compilation environment.
- ⚠ The firmware is not stable at the moment and is actively being developed at.
- ⚠ Don't install the BWM addon board for now.
Proxmark3 RDV4
See the instruction links in the tables above to build, flash and run for your Proxmark3 RDV4 device.
Generic Proxmark3 platforms
In order to build this repo for generic Proxmark3 platforms we urge you to read Advanced compilation parameters
We define generic Proxmark3 platforms as following devices.
Supported
- RDV1, RDV2, RDV3 easy
- Ryscorp green PCB version
- Radiowar black PCB version
- numerous Chinese adapted versions of the RDV3 easy (kkmoon, PiSwords etc)
- Proxmark3 SE (Special Edition) (BLE enabled)
- Proxmark3 X
- Note: Community tested
- Note: unknown device hw
- iCopy-X
- Note: Compatible ONLY after installation of iCopy-X Open Source firmware
- Factory firmware is not compatible (Client Commands are different / Factory UI closed source / Factory Firmware enforces tag DRM)
Not supported
- ⚠ Proxmark Evolution (EVO)
- Note: unknown pin assignments.
- ⚠ Ryscorp Proxmark3 Pro
- Note: device has different fpga and unknown pin assignments.
- Note: Company have disappeared, leaving their customers in the dark.
Experimental support
- ⚠ Proxmark3 Ultimate
- Note: unknown device hw
- Note: FPGA images is building for it. Use on your own risk.
Unknown support status
- ⚠ VX
- Note: unknown device hw
When it comes to these new unknown models we are depending on the community to report in if this repo works and what they did to make it work.
256KB flash memory size of generic Proxmark3 platforms
⚠ Note: You need to keep a eye on how large your ARM chip built-in flash memory is. With 512KB you are fine but if its 256KB you need to compile this repo with even less functionality. When running the
./pm3-flash-allyou can see which size your device have if you have the bootloader from this repo installed. Otherwise you will find the size reported in the start message when running the Proxmark3 client./pm3.
What has changed?
See the Changelog file which we try to keep updated.
Development
⚠ Note: This is a bleeding edge repository. The maintainers actively is working out of this repository and will be periodically re-structuring the code to make it easier to comprehend, navigate, build, test, and contribute to, so DO expect significant changes to code layout on a regular basis.
👉 Remember! If you intend to contribute to the code, please read the coding style notes first. We usually merge your contributions fast since we do like the idea of getting a functionality in the Proxmark3 and weed out the bugs afterwards.
The public roadmap is an excellent start to read if you are interesting in contributing.
Supported operating systems
This repo compiles nicely on
- WSL1 on Windows 10
- WSL2 on Windows 10/11
- Proxspace environment release v3.xx
- Windows/MinGW environment
- Ubuntu, ParrotOS, Gentoo, Pentoo, Kali, NetHunter, Arch Linux, Fedora, Debian, Raspbian
- Android / Termux
- macOS / Homebrew (or MacPorts, experimental) / Apple Silicon M1
- iOS (Jailbroken, rootful)
- Docker container
Precompiled binaries
See Proxmark3 precompiled builds
Proxmark3 GUI
Most community driven GUI for Proxmark tends to be quite old and out-of-date. Here is a list of a few:
- Proxmark3 Universal GUI will work more or less.
- Proxmark3 GUI cross-compiled which is recently updated and claims to support latest source of this repo.
- Proxmark3_GUI simple gui in vb.net
Official channels
Where do you find the community?
Maintainers
To all distro, package maintainers, we tried to make your life easier.
make install is now available and if you want to know more.
This document will be helpful for you
Citation
Use this bibtex to cite this repository globally:
@misc{proxmark3,
author = {C. {Herrmann} and P. {Teuwen} and O. {Moiseenko} and M. {Walker} and others},
title = {{Proxmark3 -- Iceman repo}},
howpublished = {\url{https://github.com/RfidResearchGroup/proxmark3}},
keywords = {rfid nfc iceman proxmark3 125khz 134khz 13.56mhz},
}
If you need to refer to a specific state of the repository, use a commit number or a date of access, e.g.:
note = {Accessed: commit 12327f71a27da23831901847886aaf20e8ad3ca0}
note = {Accessed: 2021-01-01}
Copyright and licensing terms
Each contribution is under the copyright of its author. See AUTHORS.
The Proxmark3 source code is covered by the following licensing terms, usually referred as GPLv3 or later.
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
A copy of the GPLv3 is available in LICENSE.
Some dependencies may be under other free licensing terms compatible with the Proxmark3 licensing terms, see their respective description.