proxmark3/README.md
iceman1001 ea25474731 text
2020-01-04 12:56:31 +01:00

6.7 KiB

RRG / Iceman repo - Proxmark3

Releases Linux & OSX CI Windows CI Coverity
Latest release Build status Build status Coverity Status

PROXMARK 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
Why didn't you base it on official Proxmark3 Master? Homebrew (Mac OS X) & Upgrading HomeBrew Tap Formula First Use and Verification
Proxmark3 GUI Setup and build for Windows Commands & Features
Issues Blue shark manual Advanced compilation parameters
Notes on UART Maintainers Command Cheat sheet
Notes on frame format More cheat sheets
Notes on external flash EMV
Notes on Termux / Android Troubleshooting
Notes on wireshark / tracedata JTAG
Notes on loclass Complete client command set
Notes on paths
Developing standalone mode Wiki about standalone mode
Donations

Build for non-RDV4 Proxmark3 platforms

In order to build this repo for other Proxmark3 platforms we urge you to read Advanced compilation parameters

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.

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.2
  • Windows/mingw environment with Qt5.6.1 & GCC 4.8
  • Ubuntu 1404, 1510, 1604, 1804, 1904
  • Mac OS X / Homebrew
  • ParrotOS, Gentoo, Pentoo, Kali, Nethunter, Archlinux, Fedora
  • WSL, WSL2 (Windows subsystem linux) on Windows 10
  • Docker container

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.

Notes / helpful documents

Cheat sheet

Thanks to Alex Dibs, you can enjoy a command cheat sheet

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 universal GUI will work. Proxmark3 Universal GUI Almost, change needed in order to show helptext when client isn't connected to a device.

Issues

Please see the Proxmark Forum and see if your issue is listed in the first instance Google is your friend :) Questions will be answered via the forum by Iceman and the team.

Read the Troubleshooting guide to weed out most known problems.

The end

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.

https://www.patreon.com/iceman1001