| .github | ||
| .vscode | ||
| armsrc | ||
| bootrom | ||
| client | ||
| common | ||
| common_arm | ||
| common_fpga | ||
| doc | ||
| docker | ||
| driver | ||
| fpga | ||
| include | ||
| recovery | ||
| tools | ||
| traces | ||
| .coverity.conf.sample | ||
| .gitattributes | ||
| .gitignore | ||
| .lsan_suppressions | ||
| .travis.yml.old | ||
| appveyor.yml | ||
| CHANGELOG.md | ||
| COMPILING.txt | ||
| covbuild.sh | ||
| covconfig.sh | ||
| covsubmit.sh | ||
| HACKING.md | ||
| LICENSE.txt | ||
| Makefile | ||
| Makefile.defs | ||
| Makefile.host | ||
| Makefile.platform.sample | ||
| pm3 | ||
| pm3-flash | ||
| pm3-flash-all | ||
| pm3-flash-bootrom | ||
| pm3-flash-fullimage | ||
| prox.png | ||
| rdv40.txt | ||
| README.md | ||
RRG / Iceman - Proxmark3
| Releases | Coverity | Contributors |
|---|---|---|
 |
 |
 |
| Actions OSX CI | Actions Ubuntu CI | Windows CI |
|---|---|---|
 |
 |
PROXMARK3 INSTALLATION AND OVERVIEW
Notes / helpful documents
Build for Proxmark3 RDV4
See the instruction links in the tables above to build, flash and run for your Proxmark3 RDV4 device.
Build for generic Proxmark3 platforms
In order to build this repo for generic Proxmark3 platforms we urge you to read Advanced compilation parameters
With generic Proxmark3 platforms we mean:
- RDV1
- RDV2
- RDV3 easy
- Proxmark Evolution (needs extra care)
- Radiowar black PCB version
- Ryscorp green PCB version
- Ryscorp Pm3Pro
- VX
- numerous Chinese adapted versions of the RDV3 easy (kkmoon, pisworks etc)
⚠ Note: About flash memory size of other Proxmark3 platforms. 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?
On the hardware side:
- added flash memory 256kb.
- added smart card module
- added FPC connector
On the software side:
quite a lot, 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.
This repo compiles nicely on
- Proxspace v3.x
- Windows/mingw environment with Qt5.6.1 & GCC 4.9
- Ubuntu, ParrotOS, Gentoo, Pentoo, Kali, Nethunter, Archlinux, Fedora, Debian
- Rasbian
- Android / Termux
- Mac OS X / Homebrew / Apple Silicon M1
- WSL1 on Windows 10
- Docker container
Hardware to run client on
- PC
- Android Phone
- Raspberry Pi, Raspberry Pi Zero
- Nvidia Jetson Nano
Precompiled binaries
We don't maintain any precompiled binaries in this repo. There is community effort over at the Proxmark3 forum where @gator96100 has set up a AWS bucket with precompiled Proxspace (Mingw) binaries which is 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 use his pre-compiled Proxspace binaries do consider buy him a coffee for his efforts. Remember nothing says thank you as much as a donation.
If you are having troubles with these files, contact package maintainer @gator96100 and read the homepage of his proxmark builds or read the sticky thread at forum where known issues has been documented with regards to the precompiled builds.
Proxmark3 RDV4 devices
- Precompiled builds for RDV40 dedicated x64
- Precompiled builds for RDV40 dedicated with Bluetooth addon x64
Generic Proxmark3 devices
Roadmap
The public roadmap is an excellent start to read if you are interesting in contributing.
👉 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.
Issues & Troubleshooting
Please search the issues page here and see if your issue is listed in the first instance. Read the Troubleshooting guide to weed out most known problems.
Next place to visit is the Proxmark3 Forum.
Offical channels
Youtube channels
Iceman has quite a few videos on his channel and Quentyn has risen up the last year with good informative videos. We suggest you check them out and smash that subscribe buttons!
if you think of some more good youtube channels to be on this list, let us know!
Cheat sheet
You can enjoy a command cheat sheet and we are trying to keep it updated. Thanks to Alex Dib!
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.
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 will work more or less.
-
Proxmark3 GUI crosscompiled which is recently updated and claims to support latest source of this repo. Give it a spin and let us know how it works for you.
Donations
Nothing says thank you as much as a donation. So if you feel the love, do feel free to become a Iceman patron