.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 | ||
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 repo - Proxmark3
Releases | Linux & OSX CI | Windows CI | Coverity | Contributors |
---|---|---|---|---|
Actions OSX CI | Actions Ubuntu CI |
---|---|
PROXMARK INSTALLATION AND OVERVIEW
Notes / helpful documents
Build for non-RDV4 Proxmark3 platforms
In order to build this repo for other Proxmark3 platforms we urge you to read Advanced compilation parameters
With other 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)
side note about size of these 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-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.
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 16.04 -> 20.04
- ParrotOS, Gentoo, Pentoo, Kali, Nethunter, Archlinux, Fedora, Debian
- Rasbian
- Android / Termux
- Mac OS X / Homebrew / Apple Silicon
- WSL1 (Windows subsystem linux) on Windows 10
- Docker container
Hardware to run client on
- PC
- Android
- 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 google drive with many mingw binaries which is up-to-date. We link to these files here as to make it easier for users. If you are having troubles with these files, contact the package maintainer @gator96100 and read the sticky thread at forum where known issues has been documented.
Ref: For Proxmark3 RDV4
For Proxmark3 RDV4 with blueshark addon
Generice Proxmark3 devices (non RDV4), for Proxmark3 Easy, RDV1, RDV2, RDV3, etc etc
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. Learn to search it well and finally Google / duckduckgo is your friend :) You will find many blogposts, youtube videos, tweets, reddit
Offical channels
- Proxmark3 community discord server
- Proxmark3 IRC channel
- Proxmark3 sub reddit
- Proxmark3 Twitter
- Proxmark3 forum
- no slack channel
Iceman has quite a few videos on his youtube channel
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.
Why didn't you base it on official Proxmark3 Master?
The separation from official Proxmark3 repo gives us a lot of freedom to create a firmware/client that suits the RDV40 features. We don't want to mess up the official Proxmark3 repo with RDV40 specific code.
Proxmark3 GUI
The official PM3-GUI from Gaucho will not work.
The new Proxmark3 Universal GUI will work more or less. Change is needed in order to show helptext when client isn't connected to a device. We don't know how active the maintainers are. There has been brought to our attention that there is quite a few Chinese Windows GUI available. Usually you find them on alibaba / taobao ads but we have no idea which fw/client they are compatible with. Proceed with caution if you decide to go down that road.
Donations
Nothing says thank you as much as a donation. So if you feel the love, do feel free to become a iceman patron. For some tiers it comes with rewards.