cvs.zerfleddert.de Git - proxmark3-svn/blob - README.md

   1 The iceman fork
   2 ---------------
   3
   4 NOTICE:
   5
   6 ::THIS FORK IS HIGHLY EXPERIMENTAL::
   7
   8 The official Proxmark repository is found here: https://github.com/Proxmark/proxmark3
   9
  10 NEWS:
  11
  12 ## Build Status Travis CI
  13 [![Build Status](https://travis-ci.org/iceman1001/proxmark3.svg?branch=master)](https://travis-ci.org/iceman1001/proxmark3)
  14
  15 ## Build Status Coverity Scan
  16 [![Coverity Scan Build Status](https://scan.coverity.com/projects/5117/badge.svg)](https://scan.coverity.com/projects/proxmark3-iceman-fork)
  17
  18
  19 ## Coverity Scan Config && Run
  20
  21 Download the Coverity Scan Self-buld and install it.
  22 You will need to configure  ARM-NON-EABI- Compiler for it to use:
  23
  24 :: Configure
  25 cov-configure --comptype gcc --compiler  /opt/devkitpro/devkitARM/bin/arm-none-eabi-gcc
  26
  27 ::run it (I'm running on Ubuntu)
  28 cov-build --dir cov-int make all
  29
  30 :: make a tarball
  31 tar czvf proxmark3.tgz cov-int
  32
  33 :: upload it to coverity.com
  34
  35 ## Whats changed?
  36
  37 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.
  38 Among the stuff is
  39
  40         * Jonor's hf 14a raw timing patch
  41         * Piwi's updates. (usually gets into the master)
  42         * Piwi's "topaz" branch
  43         * Piwi's "hardnested" branch
  44         * Holiman's iclass, (usually gets into the master)
  45         * Marshmellow's fixes (usually gets into the master)
  46         * Midnitesnake's Ultralight,  Ultralight-c enhancements
  47         * Izsh's lf peak modification / iir-filtering
  48         * Aspers's tips and tricks from inside the PM3-gui-tool, settings.xml and other stuff.
  49         * My own desfire, Ultralight extras, LF T55xx enhancements, bugs fixes (filelength, hf mf commands ), TNP3xxx lua scripts,  Awid26,  skidata scripts (will come)
  50         * other obscure patches like for the sammy-mode,  (offline you know), tagidentifications, defaultkeys.
  51         * Minor textual changes here and there.
  52         * Simulation of Ultralight/Ntag.
  53         * Marshmellow's and my "RevEng" addon for the client.  Ref: http://reveng.sourceforge.net/
  54         * Someone's alternative bruteforce Mifare changes.. (you need the two other exe to make it work)
  55
  56         * A Bruteforce for T55XX passwords against tag.
  57         * A Bruteforce for AWID 26, starting w a facilitycode then trying all 0xFFFF cardnumbers via simulation. To be used against a AWID Reader.
  58         * A Bruteforce for HID,  starting w a facilitycode then trying all 0xFFFF cardnumbers via simulation. To be used against a HID Reader.
  59         * Blaposts Crapto1 v3.3
  60
  61
  62 Give me a hint, and I'll see if I can't merge in the stuff you have.
  63
  64 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.
  65
  66 PM3 GUI:
  67 --------
  68 I do tend to rename and move stuff around, the official PM3-GUI from Gaucho will not work so well. *sorry*
  69
  70
  71
  72 DEVELOPMENT:
  73 ------------
  74 This fork now compiles just fine on
  75         windows/mingw environment with Qt5.3.1 & GCC 4.8
  76         Ubuntuu 1404, 1510
  77         Mac OS X
  78
  79 SETUP AND BUILD FOR UBUNTU
  80 --------------------------
  81
  82 GC made updates to allow this to build easily on Ubuntu 14.04.2 LTS or 15.10
  83 See https://github.com/Proxmark/proxmark3/wiki/Ubuntu%20Linux
  84
  85 Run
  86         -> sudo apt-get install p7zip git build-essential libreadline5 libreadline-dev libusb-0.1-4 libusb-dev libqt4-dev perl pkg-config wget
  87
  88 Follow these instructions
  89 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):
  90
  91 (64-bit) http://sourceforge.net/projects/devkitpro/files/devkitARM/previous/devkitARM_r41-x86_64-linux.tar.bz2/download
  92 (32-bit) http://sourceforge.net/projects/devkitpro/files/devkitARM/previous/devkitARM_r41-i686-linux.tar.bz2/download
  93
  94 Extract the contents of the .tar.bz2:
  95         ->  tar jxvf devkitARM_r41-<arch>-linux.tar.bz2
  96
  97 Create a directory for the arm dev kit:
  98         ->  sudo mkdir -p /opt/devkitpro/
  99
 100 Move the ARM developer kit to the newly created directory:
 101         -> sudo mv devkitARM /opt/devkitpro/
 102
 103 Add the appropriate environment variable:
 104         -> export PATH=${PATH}:/opt/devkitpro/devkitARM/bin/
 105
 106 Add the environment variable to your profile:
 107         -> echo 'PATH=${PATH}:/opt/devkitpro/devkitARM/bin/ ' >> ~/.bashrc
 108
 109 Clone iceman fork
 110         -> git clone https://github.com/iceman1001/proxmark3.git
 111
 112 Get the latest commits
 113         -> git pull
 114
 115 CLEAN COMPILE
 116         -> make clean && make all
 117
 118 Flash the BOOTROM
 119         -> client/flasher -b /dev/ttyACM0 bootrom/obj/bootrom.elf
 120
 121 Flash the FULLIMAGE
 122         -> client/flasher /dev/ttyACM0 armsrc/obj/fullimage.elf
 123
 124 Change into the client folder.
 125         -> cd client
 126
 127 Run the client
 128         -> ./proxmark3 /dev/ttyACM0
 129
 130
 131 January 2015, Sweden
 132 iceman at host iuse.se
 133
 134 BUYING A PROXMARK 3
 135 -------------------
 136
 137 The Proxmark 3 device is available for purchase (assembled and tested) from the following locations:
 138
 139    * http://www.elechouse.com  (new and revised hardware package 2015)
 140
 141    I recommend you to buy this version.
 142
 143 --------------------------------------------------------------------------
 144
 145 Most of the ultra-low-volume contract assemblers could put
 146 something like this together with a reasonable yield. A run of around
 147 a dozen units is probably cost-effective. The BOM includes (possibly-
 148 outdated) component pricing, and everything is available from Digikey
 149 and the usual distributors.
 150
 151 If you've never assembled a modern circuit board by hand, then this is
 152 not a good place to start. Some of the components (e.g. the crystals)
 153 must not be assembled with a soldering iron, and require hot air.
 154
 155 The schematics are included; the component values given are not
 156 necessarily correct for all situations, but it should be possible to do
 157 nearly anything you would want with appropriate population options.
 158
 159 The printed circuit board artwork is also available, as Gerbers and an
 160 Excellon drill file.
 161
 162
 163 LICENSING:
 164
 165 This program is free software; you can redistribute it and/or modify
 166 it under the terms of the GNU General Public License as published by
 167 the Free Software Foundation; either version 2 of the License, or
 168 (at your option) any later version.
 169
 170 This program is distributed in the hope that it will be useful,
 171 but WITHOUT ANY WARRANTY; without even the implied warranty of
 172 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 173 GNU General Public License for more details.
 174
 175 You should have received a copy of the GNU General Public License
 176 along with this program; if not, write to the Free Software
 177 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 178
 179
 180 Jonathan Westhues
 181 user jwesthues, at host cq.cx
 182
 183 May 2007, Cambridge MA