Iceman Fork - Proxmark3
Go to file
Iceman ce61d94040
Merge pull request #2348 from jlitewski/plot_cursor_improvements
Marker code cleanup
2024-04-15 01:51:10 +02:00
.github update checkout api version to v4 2024-02-20 11:11:18 +01:00
.vscode Whitespace 2023-08-09 14:30:07 +02:00
armsrc fix #2346 refactored the write loop before it assumed a full t55xx memory layout. Now handles block writes to individual parts 2024-04-13 10:59:07 +02:00
bootrom Revert "Release v4.18341 - Zenith" 2024-03-20 23:31:54 +01:00
client Marker code cleanup 2024-04-14 14:58:52 -04:00
common move hitag2 crypto parts to the common folder in order to be able to use it on the client side. Some textual and minor adaptations across the bord 2024-03-27 09:32:00 +01:00
common_arm move hitag2 crypto parts to the common folder in order to be able to use it on the client side. Some textual and minor adaptations across the bord 2024-03-27 09:32:00 +01:00
common_fpga Move hardcoded value where it belongs 2023-08-24 18:22:50 +02:00
doc style 2024-04-07 11:38:51 +02:00
docker fix Tumbleweed docker 2023-09-08 15:46:49 +02:00
driver Fix style error in `udev` rules. 2024-01-28 14:21:28 -08:00
fpga own compiled 2024-02-03 16:11:00 +01:00
include move hitag2 crypto parts to the common folder in order to be able to use it on the client side. Some textual and minor adaptations across the bord 2024-03-27 09:32:00 +01:00
recovery Add INSTALLSUDO param in Makefile.platform to limit sudo to install commands, better than sudo make install... 2022-05-03 19:04:36 +02:00
tools style 2024-04-11 22:08:25 +02:00
traces update encoder config for new iclass syntax 2024-02-17 21:44:25 -05:00
.coverity.conf.sample coverity tooling: use 2020.09 and fix tests 2021-05-14 01:33:37 +02:00
.gitattributes Add .dic to gitattributes for LF, remove existing CR 2019-05-12 20:37:51 +02:00
.gitignore allow users to cache distinct Makefile.platform.xxx files 2024-03-02 13:25:01 -08:00
.lsan_suppressions Add LeakSanitizer suppressions to skip libfontconfig warnings 2020-10-07 02:05:16 +02:00
.mailmap mailmap 2022-01-08 14:25:12 +01:00
AUTHORS.md text 2024-01-05 19:27:38 +01:00
CHANGELOG.md deprecated hex2bin and bin2hex. Use `data num` instead 2024-04-13 11:30:26 +02:00
COMPILING.txt typos 2021-10-16 23:44:53 +02:00
CONTRIBUTING.md adapt contributing text 2022-01-06 00:37:34 +01:00
LICENSE.txt Adding AUTHORS and changing licensing terms from 'GPLv2 or later' to 'GPLv3 or later' to comply with components available only under 'GPLv3 or later'. Details: 2022-01-06 00:22:44 +01:00
Makefile text 2024-03-06 10:19:40 +01:00
Makefile.defs Revert "Release v4.18341 - Zenith" 2024-03-20 23:31:54 +01:00
Makefile.host do not use LD if you aren't using ld 2022-08-29 21:04:03 -04:00
Makefile.platform.sample Added led order parameter (for Proxmark3 Easy board) 2024-02-18 12:57:26 +01:00
README.md textual 2024-02-19 17:03:27 +01:00
SECURITY.md Create SECURITY.md 2022-12-10 03:45:32 +01:00
covbuild.sh added mfd aes brute tool to coverity scan 2022-07-07 16:41:43 +02:00
covconfig.sh coverity tooling: use 2020.09 and fix tests 2021-05-14 01:33:37 +02:00
covsubmit.sh style 2023-12-01 15:25:09 +01:00
pm3 Get Python support of experimental_client_with_swig working again 2023-11-13 10:13:14 +01:00
pm3-flash Use /usr/bin/env in shebangs 2020-02-18 00:00:24 +00:00
pm3-flash-all Use /usr/bin/env in shebangs 2020-02-18 00:00:24 +00:00
pm3-flash-bootrom Use /usr/bin/env in shebangs 2020-02-18 00:00:24 +00:00
pm3-flash-fullimage use env in shebangs in pm3-flash-fullimage and rest of tools 2020-02-19 16:13:17 +00:00

README.md

Iceman Fork - Proxmark3

The Proxmark3 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 LUA scripts to automate chip identification, penetration testing, and programming

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

Table of Contents

PROXMARK3 INSTALLATION AND OVERVIEW

Installation Use of the Proxmark3
Linux - Setup and Build Compilation Instructions
Linux - Important notes on ModemManager Validating Proxmark3 Client Functionality
macOS - Homebrew & Upgrading HomeBrew Tap Formula First Use and Verification
macOS - MacPorts Commands & Features
macOS - Setup and Build
Windows - Setup and Build
Termux / Android - Setup and Build
iOS - Setup and Build
Blue Shark Manual Command Cheat Sheet
Advanced Compilation Parameters More Cheat Sheets
Troubleshooting Complete Client Command Set
JTAG T5577 Introduction Guide

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 UID cards
Notes on Color usage Makefile vs CMake Notes on Cloner guns
Notes on cliparser usage Notes on clocks Notes on MIFARE DESFire
Notes on CIPURSE Notes on NDEF type4a Notes on downgrade attacks

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)
  • Proxmark3 SE (Special Edition) (BLE enabled)
  • Proxmark3 X
    • Note: Community tested
    • Note: unknown device hw

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

  • ⚠ iCopy-X
    • Note: currently incompatible with iCopy-X GUI as Proxmark client commands using different syntax
    • Note: see also icopyx-community repos for upstream sources, reversed hw etc.
    • Note: Uses DRM to lock down tags, ignores the open source licences. Use on your own risk.

Unknown support status

  • ⚠ VX
    • Note: unknown device hw
  • ⚠ Proxmark3 Ultimate
    • 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-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.

  • Supports command tab complete
  • 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 (v2.6)
    • 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
  • Supports CIPURSE
  • 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
  • Available as package on known distros like Gentoo, Kali, Termux, Macports, Homebrew
  • Much 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{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}

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.