169 lines
9.9 KiB
Markdown
169 lines
9.9 KiB
Markdown
# RRG / Iceman - Proxmark3
|
|
|
|
|
|
| Releases | Coverity | Contributors |
|
|
| ------------------- | -------------------:| -------------------:|
|
|
| [](https://github.com/RfidResearchGroup/proxmark3/releases/latest) | [](https://scan.coverity.com/projects/proxmark3-rrg-iceman-repo)|  |
|
|
|
|
|
|
| Actions OSX CI | Actions Ubuntu CI | Windows CI |
|
|
| ------------------- | -------------------:| -------------------:|
|
|
|  |  | [](https://ci.appveyor.com/project/RfidResearchGroup/proxmark3/branch/master) |
|
|
|
|
|
|
|
|
# PROXMARK3 INSTALLATION AND OVERVIEW
|
|
|
|
| FAQ's & Updates | Installation | Use of the Proxmark |
|
|
| ------------------- |:-------------------:| -------------------:|
|
|
|[What has changed?](#what-has-changed) | **[Setup and build for Linux](/doc/md/Installation_Instructions/Linux-Installation-Instructions.md)** | [Compilation Instructions](/doc/md/Use_of_Proxmark/0_Compilation-Instructions.md)|
|
|
|[Development](#development) | **[Important notes on ModemManager for Linux users](/doc/md/Installation_Instructions/ModemManager-Must-Be-Discarded.md)** | [Validating proxmark client functionality](/doc/md/Use_of_Proxmark/1_Validation.md) |
|
|
|[Maintainers](#maintainers--package-distro-)| **[Homebrew (Mac OS X) & Upgrading HomeBrew Tap Formula](/doc/md/Installation_Instructions/Mac-OS-X-Homebrew-Installation-Instructions.md)** | [First Use and Verification](/doc/md/Use_of_Proxmark/2_Configuration-and-Verification.md)|
|
|
|[Proxmark3 GUI](#proxmark3-gui)|**[Setup and build for Windows](/doc/md/Installation_Instructions/Windows-Installation-Instructions.md)**|[Commands & Features](/doc/md/Use_of_Proxmark/3_Commands-and-Features.md)|
|
|
|[Pre-compiled binaries](#precompiled-binaries)|[Blue shark manual](/doc/bt_manual_v10.md) ||
|
|
|[Donations](#donations)||[Command Cheat sheet](/doc/cheatsheet.md)|
|
|
||[Advanced compilation parameters](/doc/md/Use_of_Proxmark/4_Advanced-compilation-parameters.md)|[More cheat sheets](https://github.com/RfidResearchGroup/proxmark3/wiki/More-cheat-sheets)|
|
|
||**[Troubleshooting](/doc/md/Installation_Instructions/Troubleshooting.md)**|[Complete client command set](/doc/commands.md)|
|
|
||**[JTAG](/doc/jtag_notes.md)**|[T5577 Introduction Guide](/doc/T5577_Guide.md)|
|
|
|
|
|
|
## Notes / helpful documents
|
|
|
|
| Notes |||
|
|
| ------------------- |:-------------------:| -------------------:|
|
|
|[Notes on UART](/doc/uart_notes.md)|[Notes on Termux / Android](/doc/termux_notes.md)|[Notes on paths](/doc/path_notes.md)|
|
|
|[Notes on frame format](/doc/new_frame_format.md)|[Notes on tracelog / wireshark](/doc/trace_notes.md)|[Notes on EMV](/doc/emv_notes.md)|
|
|
|[Notes on external flash](/doc/ext_flash_notes.md)|[Notes on loclass](/doc/loclass_notes.md)|[Notes on Coverity Scan Config & Run](/doc/md/Development/Coverity-Scan-Config-and-Run.md)|
|
|
|[Notes on file formats used with Proxmark3](/doc/extensions_notes.md)|[Notes on MFU binary format](/doc/mfu_binary_format_notes.md)|[Notes on FPGA & ARM](/doc/fpga_arm_notes.md)|
|
|
|[Developing standalone mode](/armsrc/Standalone/readme.md)|[Wiki about standalone mode](https://github.com/RfidResearchGroup/proxmark3/wiki/Standalone-mode)|[Notes on Magic cards](/doc/magic_cards_notes.md)|
|
|
|[Notes on Color usage](/doc/colors_notes.md)|[Makefile vs CMake](/doc/md/Development/Makefile-vs-CMake.md)|[Notes on Cloner guns](/doc/cloner_notes.md)|
|
|
|[Notes on cliparser usage](/doc/cliparser.md)|[Notes on clocks](/doc/clocks.md)||
|
|
|
|
# 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](/doc/md/Use_of_Proxmark/4_Advanced-compilation-parameters.md)
|
|
|
|
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, pisworks etc)
|
|
|
|
**Not supported**
|
|
- ⚠ Proxmark Evolution (EVO)
|
|
- **Note**: unknown pin assignments.
|
|
- ⚠ Ryscorp Proxmark3 Pro
|
|
- **Note**: device has different fpga and unknown pin assignments.
|
|
|
|
**Unknown support status**
|
|
- ⚠ VX
|
|
|
|
**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](/doc/md/Use_of_Proxmark/4_Advanced-compilation-parameters.md#256kb-versions)
|
|
|
|
|
|
## 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](CHANGELOG.md) 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](https://scan.coverity.com/projects/proxmark3-rrg-iceman-repo/)
|
|
* Cppcheck
|
|
* GCC and Clang aggressive enforcement of diagnostic flags
|
|
* auto detection of serial ports and seamless integration with Bluetooth addon
|
|
* reconnect to device
|
|
|
|
|
|
## 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](HACKING.md) 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](https://github.com/RfidResearchGroup/proxmark3/wiki/Public-Roadmap) is an excellent start to read if you are interesting in contributing.
|
|
|
|
|
|
## Supported operative systems
|
|
This repo compiles nicely on
|
|
- WSL1 on Windows 10
|
|
- Proxspace v3.9 [release v3.9](https://github.com/Gator96100/ProxSpace/releases)
|
|
- Windows/MinGW environment
|
|
- Ubuntu, ParrotOS, Gentoo, Pentoo, Kali, NetHunter, Arch Linux, Fedora, Debian, Raspbian
|
|
- Android / Termux
|
|
- Mac OS X / Homebrew / Apple Silicon M1
|
|
- Docker container
|
|
- [ RRG / Iceman repo based ubuntu 18.04 container ](https://hub.docker.com/r/secopsconsult/proxmark3)
|
|
- [ Iceman fork based container v1.7 ](https://hub.docker.com/r/iceman1001/proxmark3/)
|
|
|
|
|
|
## Precompiled binaries
|
|
We don't maintain any precompiled binaries in this repo. There is community effort over at the Proxmark3 forum where package maintainer [@gator96100](https://github.com/gator96100) has set up a AWS bucket with precompiled Proxspace (MinGW) binaries which are recompiled every night and with that also up-to-date. We link to these files here as to make it easier for users. If you are having troubles with these files, we suggest to read the [homepage of his proxmark builds](https://www.proxmarkbuilds.org/) or read the [sticky thread at forum](http://www.proxmark.org/forum/viewtopic.php?pid=24763#p24763)
|
|
|
|
### Proxmark3 RDV4 devices
|
|
- [Precompiled builds for RDV40 dedicated x64](https://www.proxmarkbuilds.org/#rdv40-64/)
|
|
- [Precompiled builds for RDV40 dedicated with Bluetooth addon x64](https://www.proxmarkbuilds.org/#rdv40_bt-64/)
|
|
|
|
### Generic Proxmark3 devices
|
|
- [Precompiled builds for RRG / Iceman repository x64](https://www.proxmarkbuilds.org/#rrg_other-64/)
|
|
|
|
|
|
## Official channels
|
|
Where do you find the community?
|
|
- [RFID Hacking community discord server](https://discord.gg/QfPvGFRQxH)
|
|
- [Proxmark3 IRC channel](http://webchat.freenode.net/?channels=#proxmark3)
|
|
- [Proxmark3 sub reddit](https://www.reddit.com/r/proxmark3/)
|
|
- [Proxmark3 forum](http://www.proxmark.org/forum/index.php)
|
|
|
|
|
|
## Maintainers ( package, distro )
|
|
|
|
To all distro, package maintainers, we tried to make your life easier.
|
|
|
|
`make install` is now available and if you want to know more.
|
|
- [Notes for maintainers](/doc/md/Development/Maintainers.md)
|
|
|
|
## Proxmark3 GUI
|
|
|
|
The official PM3-GUI from Gaucho will not work. Not to mention is quite old and not maintained any longer.
|
|
|
|
- [Proxmark3 Universal GUI](https://github.com/burma69/PM3UniversalGUI) will work more or less.
|
|
|
|
- [Proxmark3 GUI cross-compiled](https://github.com/wh201906/Proxmark3GUI/) which is recently updated and claims to support latest source of this repo.
|
|
|
|
|
|
# Donations
|
|
|
|
Nothing says thank you as much as a donation.
|
|
|
|
If you feel the love, do feel free to become a [Iceman patron](https://www.patreon.com/iceman1001).
|
|
|
|
If you are using @gator96100 's Proxspace with pre-compiled binaries do consider buy him a coffee for his efforts.
|