explaingit

rfidresearchgroup/proxmark3

5,628CAudience · ops devopsComplexity · 4/5Setup · hard

TLDR

Firmware and software for the Proxmark3 USB device that lets you read, analyze, clone, and interact with RFID contactless cards and access badges.

Mindmap

mindmap
  root((proxmark3))
    What it does
      Read RFID cards
      Clone access badges
      Analyze protocols
      Automate with scripts
    Supported protocols
      MIFARE
      HID iClass
      ISO14443
      Hitag2
    Tech Stack
      C firmware
      ARM processor
      Lua scripting
    Platforms
      Linux
      macOS
      Windows
      Android Termux
Click or tap to explore — scroll the page freely

Code map

Detail Auto

An interactive map of this repo's files and how they connect — its source is parsed live in your browser. Click Visualize to build it.

filefunction / class

Things people build with this

USE CASE 1

Read and identify the chip type and protocol of an unknown contactless access card or transit pass.

USE CASE 2

Clone a compatible RFID badge to a blank card for authorized testing of physical access control systems.

USE CASE 3

Write Lua scripts to automate RFID chip identification and security auditing tasks on supported card types.

USE CASE 4

Run the device in standalone mode without a connected computer to capture card data in the field.

Tech stack

CLuaARM

Getting it running

Difficulty · hard Time to first run · 1h+

Requires a Proxmark3 hardware device (RDV4 recommended) and platform-specific build toolchain including ARM cross-compiler.

License information was not mentioned in the explanation.

In plain English

Proxmark3 (Iceman Fork) is a firmware and software suite for the Proxmark3, a hardware device used to read, analyze, clone, and interact with RFID cards and tags. RFID is the technology behind contactless key cards, transit passes, and many access control badges. The Proxmark3 hardware connects to a computer via USB and can communicate with these cards at close range. The Iceman fork is the most widely used community version of the Proxmark3 software. It extends the original firmware with a large command set accessible through a command-line client, plus Lua scripting support for automating tasks such as chip identification and security testing. Supported protocols include MIFARE, HID iClass, Hitag2, and the broader ISO14443 contactless standard, covering a wide range of card types in active use. The repository includes detailed documentation organized into separate files, covering installation on Linux, macOS, Windows, Android via Termux, and iOS. Each platform has its own build guide. There is also a cheat sheet of common commands, a guide to standalone mode where the device runs scripts without a connected computer, and technical notes on specific protocols and file formats. Hardware support focuses on the RDV4 model but also covers many earlier and third-party Proxmark3 variants. Some devices are listed as unsupported due to unknown hardware configurations, and a few are flagged as experimental with known compatibility issues. The code is written in C and covers both the ARM firmware that runs on the device and the desktop client used to control it. The project was originally created by Jonathan Westhues. The Iceman fork is maintained by the RFID Research Group and accepts community contributions.

Copy-paste prompts

Prompt 1
Using the proxmark3 Iceman fork, show me the commands to identify the protocol and chip type of an unknown contactless card placed on the antenna.
Prompt 2
Walk me through cloning a MIFARE Classic card using proxmark3 commands, including how to handle sectors that need authentication keys.
Prompt 3
Help me write a Lua script for proxmark3 that automatically reads a card, logs the UID and sector data to a file, and plays a beep on success.
Prompt 4
Set up the proxmark3 Iceman fork client on Ubuntu, flash the latest RDV4 firmware, and run the self-test to confirm everything is working.
Open on GitHub → Explain another repo

← rfidresearchgroup on gitmyhub — every repo by this author, as a profile.

Verify against the repo before relying on details.