MsprgandClaude Fable 5.1
0cd1fada0e
The USB-unplug power-off left two ways to drain the battery: a PM5 woken by the button and forgotten, and one left idle after the phone disconnected. Idle trigger (opt-in, PM5_AUTOOFF_IDLE_MS 0 by default so out of the box only the unplug trigger exists, as before): on battery the board powers off after the idle timeout with no interaction and no wireless client. Interaction is a received command over any transport, any button press, or a client connecting or leaving; a standalone mode or a long-running command holds the main loop, so neither can be cut short. The BWM reports its clients with the LINK_STATE broadcast (8092, companion Proxmark5_BWM_esp32 PR) which bwm_forward.c tracks; at boot the BLE half is seeded with a status query since the module only reports changes. When the timer is due but a client is still tracked, the module is asked for its BLE state (at most every 10 s), so a lost "client left" broadcast cannot pin the board on. And right before going off the module is asked once more: older module firmware never sends the broadcast and a "connected" one can get lost, and neither may power the board off under a silent BLE client. No answer means off. --unplug off: the unplug trigger always won, so "survive the unplug, go off after N idle seconds" was not reachable. It is its own setting (default on = unchanged). With it off an unplug only restarts the idle clock - from the unplug, not from the last command, or a board that sat idle on USB for an hour would still die with the cable. Unplug detection is edge-based (VUSB present at the previous poll, absent at this one) instead of "absent and seen since boot", which would fire on every poll after a tolerated unplug. VUSB is followed while the feature is switched off too, so switching it on again on battery is not taken for an unplug. Stored on the BWM: runtime-only settings reset at every boot, which is exactly when the idle trigger matters. The PM5 has no settings store, so the switch, the idle timeout and the unplug switch live in the module's host value slots (APP_CMD_SET/GET_SYS_HOST_VALUE 1021/1022, companion PR; slot 0 switch, 1 idle seconds, 2 unplug), loaded at the first auto-off poll and saved by CMD_PM5_BWM_AUTOOFF with 1 s per write, so a silent or older module still leaves the reply inside the client's 5 s wait. Without a module, or with an older one, the defaults apply and the status says "not stored". hw bwm autooff [on|off] [--idle <sec>] [--unplug <on|off>]; no argument shows the state, one fact per line: switch, idle timeout, unplug power-off, stored on module, USB power, USB seen since boot, unplug trigger armed, tracked client, the module's BLE state, idle time. Payload [action][enabled][idle_s u32][unplug, optional] with keep sentinels; both actions are non-zero so an old firmware, which reads byte 0 as the enable flag, can only be left enabled. hw status prints the module's live BLE state and the auto power-off setting; at debug level also the tracked client, which should agree with the live state. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
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.