git.zerfleddert.de Git - proxmark3-svn/blob - README.txt

   1 The iceman fork
   2 ---------------
   3
   4 NOTICE:
   5
   6 The official Proxmark repository is found here: https://github.com/Proxmark/proxmark3
   7
   8 NEWS:
   9
  10 ::THIS FORK IS HIGHLY EXPERIMENTAL::
  11
  12
  13 ## Build Status Travis CI
  14 [![Build Status](https://travis-ci.org/iceman1001/proxmark3.svg?branch=master)](https://travis-ci.org/iceman1001/proxmark3)
  15
  16 ## Build Status Coverity Scan
  17 [![Coverity Scan Build Status](https://scan.coverity.com/projects/5117/badge.svg)](https://scan.coverity.com/projects/proxmark3-iceman-fork)
  18
  19
  20 Whats in this fork?  I have scraped the web for different enhancements to the PM3 source code and not all of them ever found their way to the master branch.
  21 Among the stuff is
  22
  23         * Jonor's hf 14a raw timing patch
  24         * Piwi's updates. (usually gets into the master)
  25         * Piwi's "topaz" branch
  26         * Piwi's "hardnested" branch
  27         * Holiman's iclass, (usually gets into the master)
  28         * Marshmellow's fixes (usually gets into the master)
  29         * Midnitesnake's Ultralight,  Ultralight-c enhancements
  30         * Izsh's lf peak modification / iir-filtering
  31         * Aspers's tips and tricks from inside the PM3-gui-tool, settings.xml and other stuff.
  32         * My own desfire, Ultralight extras, LF T55xx enhancements, bugs fixes (filelength, hf mf commands ), TNP3xxx lua scripts,  Awid26,  skidata scripts (will come)
  33         * other obscure patches like for the sammy-mode,  (offline you know), tagidentifications, defaultkeys.
  34         * Minor textual changes here and there.
  35         * Simulation of Ultralight/Ntag.
  36         * Marshmellow's and my "RevEng" addon for the client.  Ref: http://reveng.sourceforge.net/
  37         * Someone's alternative bruteforce Mifare changes.. (you need the two other exe to make it work)
  38
  39         * A Bruteforce for T55XX passwords against tag.
  40         * A Bruteforce for AWID 26, starting w a facilitycode then trying all 0xFFFF cardnumbers via simulation. To be used against a AWID Reader.
  41         * A Bruteforce for HID,  starting w a facilitycode then trying all 0xFFFF cardnumbers via simulation. To be used against a HID Reader.
  42         * Blaposts Crapto1 v3.3
  43     * Icsom's  legic script and legic enhancements
  44     * Azcid's bitsliced bruteforce solver in 'hf mf hardnested'
  45
  46 Give me a hint, and I'll see if I can't merge in the stuff you have.
  47
  48 I don't actually know how to make small pull-request to github :( and that is the number one reason for me not pushing a lot of things back to the PM3 master.
  49
  50 PM3 GUI:
  51
  52 I do tend to rename and move stuff around, the official PM3-GUI from Gaucho will not work so well. *sorry*
  53
  54
  55
  56 DEVELOPMENT:
  57
  58 This fork is adjusted to compile on windows/mingw environment with Qt5.3.1 & GCC 4.9
  59 For people with linux you will need to patch some source code and some small change to one makefile.  If you are lazy, you google the forum and find asper's or holimans makefile or you find your solution below.
  60
  61 GC made updates to allow this to build easily on Ubuntu 14.04.2 LTS.
  62         - See https://github.com/Proxmark/proxmark3/wiki/Ubuntu%20Linux
  63         - Generally speaking, if you're running a "later" Proxmark, installation is very easy.
  64         - Run "sudo apt-get install p7zip git build-essential libreadline5 libreadline-dev libusb-0.1-4 libusb-dev libqt4-dev perl pkg-config wget
  65         - Follow these instructions
  66         Get devkitARM release 41 from SourceForge (choose either the 64/32 bit depending on your architecture, it is assumed you know how to check and recognize your architecture):
  67                         (64-bit) http://sourceforge.net/projects/devkitpro/files/devkitARM/previous/devkitARM_r41-x86_64-linux.tar.bz2/download
  68                         (32-bit) http://sourceforge.net/projects/devkitpro/files/devkitARM/previous/devkitARM_r41-i686-linux.tar.bz2/download
  69                         Extract the contents of the .tar.bz2:
  70                                         tar jxvf devkitARM_r41-<arch>-linux.tar.bz2
  71                         Create a directory for the arm dev kit:
  72                                         sudo mkdir -p /opt/devkitpro/
  73                         Move the ARM developer kit to the newly created directory:
  74                                         sudo mv devkitARM /opt/devkitpro/
  75                         Add the appropriate environment variable:
  76                                         export PATH=${PATH}:/opt/devkitpro/devkitARM/bin/
  77                         Add the environment variable to your profile:
  78                                         echo 'PATH=${PATH}:/opt/devkitpro/devkitARM/bin/ ' >> ~/.bashrc
  79         - make all
  80
  81 Common errors linux/macOS finds
  82
  83 Error:
  84         * \client\makefile  the parameter -lgdi32
  85 Solution:
  86         * Remove parameter.
  87
  88 Error:
  89         * Using older Qt4.6 gives compilation errors.
  90 Solution
  91         * Upgrade to Qt5.3.1
  92         OR
  93         * Change these two line in  \client\makefile
  94                 CXXFLAGS = -I$(QTDIR)/include -I$(QTDIR)/include/QtCore -I$(QTDIR)/include/QtGui -I$(QTDIR)/include/QtWidgets  -I/mingw/include
  95                 QTLDLIBS = -L$(QTDIR)/lib  -lQt5Core -lQt5Gui -lQt5Widgets
  96
  97                 TO
  98
  99                 CXXFLAGS = -I$(QTDIR)/include -I$(QTDIR)/include/QtCore -I$(QTDIR)/include/QtGui
 100                 QTLDLIBS = -L$(QTDIR)/lib -lQtCore4 -lQtGui4
 101
 102
 103 An old Qt4 version makefile is found here: http://www.icesql.se/proxmark3/code/linuxmakefile.txt  but this one doesn't have all new files in it. So I don't recommend it.
 104
 105
 106 January 2015, Sweden
 107 iceman at host iuse.se
 108
 109
 110 The Proxmark 3 is available for purchase (assembled and tested) from the
 111 following locations:
 112
 113    * http://www.elechouse.com  (new and revised hardware package 2015)
 114
 115
 116 Most of the ultra-low-volume contract assemblers could put
 117 something like this together with a reasonable yield. A run of around
 118 a dozen units is probably cost-effective. The BOM includes (possibly-
 119 outdated) component pricing, and everything is available from Digikey
 120 and the usual distributors.
 121
 122 If you've never assembled a modern circuit board by hand, then this is
 123 not a good place to start. Some of the components (e.g. the crystals)
 124 must not be assembled with a soldering iron, and require hot air.
 125
 126 The schematics are included; the component values given are not
 127 necessarily correct for all situations, but it should be possible to do
 128 nearly anything you would want with appropriate population options.
 129
 130 The printed circuit board artwork is also available, as Gerbers and an
 131 Excellon drill file.
 132
 133
 134 LICENSING:
 135
 136 This program is free software; you can redistribute it and/or modify
 137 it under the terms of the GNU General Public License as published by
 138 the Free Software Foundation; either version 2 of the License, or
 139 (at your option) any later version.
 140
 141 This program is distributed in the hope that it will be useful,
 142 but WITHOUT ANY WARRANTY; without even the implied warranty of
 143 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 144 GNU General Public License for more details.
 145
 146 You should have received a copy of the GNU General Public License
 147 along with this program; if not, write to the Free Software
 148 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 149
 150
 151 Jonathan Westhues
 152 user jwesthues, at host cq.cx
 153
 154 May 2007, Cambridge MA