Skip to content
master
Switch branches/tags
Code

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
doc
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
pm3
 
 
 
 
 
 

RRG / Iceman - Proxmark3

Releases Coverity Contributors
Latest release Coverity Status GitHub contributors
Actions OSX CI Actions Ubuntu CI Windows CI
MacOS Build and Test Ubuntu Build and Test Build status

Table of Contents

  1. PROXMARK3 INSTALLATION AND OVERVIEW
  2. Notes / helpful documents
  3. How to build?
    1. Proxmark3 RDV4
    2. Generic Proxmark3 platforms
  4. What has changed?
  5. Development
  6. Supported operative systems
  7. Precompiled binaries
  8. Proxmark3 GUI
  9. Official channels
  10. Maintainers
  11. Citation

PROXMARK3 INSTALLATION AND OVERVIEW

FAQ's & Updates Installation Use of the Proxmark
What has changed? Setup and build for Linux Compilation Instructions
Development Important notes on ModemManager for Linux users Validating proxmark client functionality
Maintainers Homebrew (Mac OS X) & Upgrading HomeBrew Tap Formula First Use and Verification
Proxmark3 GUI Setup and build for Windows Commands & Features
Pre-compiled binaries Blue shark manual
Donations Command Cheat sheet
Advanced compilation parameters More cheat sheets
Troubleshooting Complete client command set
JTAG T5577 Introduction Guide
MacPorts (Mac OS X, experimental)

Notes / helpful documents

Notes
Notes on UART Notes on Termux / Android Notes on paths
Notes on frame format Notes on tracelog / wireshark Notes on EMV
Notes on external flash Notes on loclass Notes on Coverity Scan Config & Run
Notes on file formats used with Proxmark3 Notes on MFU binary format Notes on FPGA & ARM
Developing standalone mode Wiki about standalone mode Notes on Magic cards
Notes on Color usage Makefile vs CMake Notes on Cloner guns
Notes on cliparser usage Notes on clocks Notes on DESFire usage

How to build?

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)

Not supported

  • Proxmark Evolution (EVO)
    • Note: unknown pin assignments.
  • Ryscorp Proxmark3 Pro
    • Note: device has different fpga and unknown pin assignments.
  • iCopy-X
    • Note: experimental support, currently incompatible with iCopy-X GUI as Proxmark client commands are now using cliparser.
    • Note: see also icopyx-community repos for upstream sources, reversed hw etc.

Unknown support status

  • VX
    • Note: unknown device hw

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-all you 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.

OBS! Read the 256kb flash memory advisory

What has changed?

Proxmark3 RDV4 hardware modifications:

  • added flash memory 256kb
  • added smart card module
  • added FPC connector for peripherals such as Bluetooth+battery addon
  • improved antennas
    • swappable
    • LF Q factor switch
    • LF 125/134 frequency switch
  • tiny PCB form factor
  • ABS case

This repo vs official Proxmark3 repo: see the Changelog file which we try to keep updated. In short this repo gives you a completely different user experience when it comes to Proxmark3.

  • richer CLI with use of colors / emojis
  • help text system implemented everywhere
  • hints system
  • user preference settings
  • extensive testing with continuous integration build systems on Linux, OSX and Windows, and regular usage of static analysis tools like
    • Coverity Scan
    • Cppcheck
    • GCC and Clang aggressive enforcement of diagnostic flags
  • auto detection of serial ports and seamless integration with Bluetooth addon
  • reconnect to device from inside client
  • Supports tearoff attacks
  • Supports NFC NDEF type1, type2, type4a, type4b, mifare, barcode
  • Supports pm3 client scripts, lua scripts, python scripts
  • Most comprehensive collection of scripts available
  • Wiegand encoding, decoding.
  • Supports EMV
  • Most standalone modes available with easy compilation
  • extensive test script for client and external tools
  • Most comprehensive compiled known keys dictionaries
  • Slimed down usb communications with NG-frames
  • the most compiled public known key recovery software
  • the fastest implementations of said software
  • support multiple fileformats for dump files (BIN/EML/JSON)
  • interoperability of said fileformats with libnfc, MFC tool app etc
  • Supports more RFID based protocols than ever
  • Easy install for package maintainers, distro maintainers
  • Supports cmake, make
  • Builds without errors or warnings on more OS/platforms than ever.
  • More documentation

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 operative systems

This repo compiles nicely on

Precompiled binaries

See Proxmark3 precompiled builds

Proxmark3 GUI

The official PM3-GUI from Gaucho will not work. Not to mention is quite old and not maintained any longer.

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{proxmark3rrg,
  author = {C. {Herrmann} and P. {Teuwen} and O. {Moiseenko} and M. {Walker} and others},
  title = {{Proxmark3 -- RRG / 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}