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

   1 The iceman fork
   2 ---------------
   3 [![Build Status](https://travis-ci.org/iceman1001/proxmark3.svg?branch=master)](https://travis-ci.org/iceman1001/proxmark3)  [![Coverity Status](https://scan.coverity.com/projects/5117/badge.svg)](https://scan.coverity.com/projects/proxmark3-iceman-fork)  [![Latest release] (https://img.shields.io/github/release/iceman1001/proxmark3.svg)] (https://github.com/iceman1001/proxmark3/releases/latest)
   4
   5 ##::THIS FORK IS HIGHLY EXPERIMENTAL::
   6
   7 ##Notice
   8
   9 There is so much in this fork,  with all fixes and additions its basically the most enhanced fork to this day for the Proxmark3 device.
  10
  11
  12 ##Offical
  13 The official Proxmark repository is found here: https://github.com/Proxmark/proxmark3
  14
  15
  16 ##Coverity Scan Config && Run
  17
  18 Download the Coverity Scan Self-buld and install it.
  19 You will need to configure  ARM-NON-EABI- Compiler for it to use:
  20
  21 :: Configure
  22 cov-configure --comptype gcc --compiler  /opt/devkitpro/devkitARM/bin/arm-none-eabi-gcc
  23
  24 ::run it (I'm running on Ubuntu)
  25 cov-build --dir cov-int make all
  26
  27 :: make a tarball
  28 tar czvf proxmark3.tgz cov-int
  29
  30 :: upload it to coverity.com
  31
  32 ##Whats changed?
  33
  34 Whats so special with 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.
  35 Among the stuff is
  36
  37         * Jonor's hf 14a raw timing patch
  38         * Piwi's updates. (usually gets into the master)
  39         * Piwi's "topaz" branch
  40         * Piwi's "hardnested" branch
  41         * Holiman's iclass, (usually gets into the master)
  42         * Marshmellow's fixes (usually gets into the master)
  43         * Midnitesnake's Ultralight,  Ultralight-c enhancements
  44         * Izsh's lf peak modification / iir-filtering
  45         * Aspers's tips and tricks from inside the PM3-gui-tool, settings.xml and other stuff.
  46         * My own desfire, Ultralight extras, LF T55xx enhancements, bugs fixes (filelength, hf mf commands ), TNP3xxx lua scripts,  Awid26,  skidata scripts (will come)
  47         * other obscure patches like for the sammy-mode,  (offline you know), tagidentifications, defaultkeys.
  48         * Minor textual changes here and there.
  49         * Simulation of Ultralight/Ntag.
  50         * Marshmellow's and my "RevEng" addon for the client.  Ref: http://reveng.sourceforge.net/    Now using reveng1.31
  51         * Someone's alternative bruteforce Mifare changes.. (you need the two other exe to make it work)
  52
  53         * A Bruteforce for T55XX passwords against tag.
  54         * A Bruteforce for AWID 26, starting w a facilitycode then trying all 0xFFFF cardnumbers via simulation. To be used against a AWID Reader.
  55         * A Bruteforce for HID,  starting w a facilitycode then trying all 0xFFFF cardnumbers via simulation. To be used against a HID Reader.
  56         * Blaposts Crapto1 v3.3
  57     * Icsom's  legic script and legic enhancements
  58     * Aczid's bitsliced bruteforce solver in 'hf mf hardnested'
  59
  60
  61 ---
  62 Straight from the CHANGELOG
  63 ---
  64   - 'lf nedap' - added identification of a NEDAP tag. (iceman)
  65   - 'lf viking clone' - fixed a bug. (iceman)
  66   - Added bitsliced bruteforce solver in 'hf mf hardnested' (aczid)
  67   - 'hf mf chk' speedup (iceman)
  68   - 'hf 14a/mf sim x" attack mode,  now uses also moebius version of mfkey32 to try finding the key. (iceman)
  69   - 'hf 14a sim' Added emulation of Mifare cards with 10byte UID length. (iceman)
  70   - 'hf mf sim' Added emulation of Mifare cards with 10byte UID length. (iceman)
  71   - Added `lf guard clone/sim` (iceman)
  72   - Added `lf pyramd clone/sim` (iceman)
  73   - trying to fix "hf 14b" command to be able to read CALYPSO card.      (iceman)
  74   - `hf legic load`, it now loads faster and a casting bug is gone. (iceman)
  75   - Added `hf legic calccrc8` added a method to calculate the legic crc-8 value (iceman)
  76   - `hf legic decode` fixed the output overflow bugs, better printing (iceman)
  77   - Coverity Scan fixes a lot of resource leaks, etc (iceman)
  78   - Added `lf presco *` commands started (iceman)
  79   - Added `lf hid wiegand` added a method to calculate WIEGAND in different formats, (iceman)
  80   - `hf mf chkkeys` better printing, same table output as nested, faster execution and added Adam Lauries "try to read Key B if Key A is found" (iceman)
  81   - `hf mf nested` better printing and added Adam Lauries "try to read Key B if Key A is found" (iceman)
  82   - `hf mf mifare` fixing the zero parity path, which doesn't got called. (iceman)
  83   - Updated the @blapost's Crapto1 implementation to v3.3 (blapost)
  84   - `hf mf c*` updated the calling structure and refactored of the chinese magic commands (iceman, marshmellow)
  85   - Started to add Peter Fillmore's  EMV fork into Iceman fork. ref: https://github.com/peterfillmore/proxmark3  (peter fillmore,  iceman)
  86   - Added Travis-CI automatic build integration with GitHub fork. (iceman)
  87   - Updated the Reveng 1.30 sourcecode to 1.31 from Reveng projecthomepage (iceman)
  88
  89   - Added possibility to write direct to a Legic Prime Tag (MIM256/1024) without using values from the 'BigBuffer' -> 'hf legic writeRaw <addr> <value>' (icsom)
  90   - Added possibility to decrease DCF values at address 0x05 & 0x06 on a Legic Prime Tag
  91                 DCF-value will be pulled from the BigBuffer (address 0x05 & 0x06) so you have to
  92                 load the data into the BigBuffer before with 'hf legic load <path/to/legic.dump>' & then
  93                 write the DCF-Values (both at once) with 'hf legic write 0x05 0x02'  (icsom)
  94   - Added script `legic.lua` for display and edit Data of Legic-Prime Tags (icsom)
  95   - Added the experimental HITAG_S support (spenneb)
  96   - Added topaz detection to `hf search` (iceman)
  97   - Fixed the silent mode for 14b to be used inside 'hf search' (iceman)
  98
  99 ---
 100
 101 Give me a hint, and I'll see if I can't merge in the stuff you have.
 102
 103 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.
 104
 105 ##PM3 GUI
 106 I do tend to rename and move stuff around, the official PM3-GUI from Gaucho will not work so well. *sorry*
 107
 108
 109
 110 ##Development
 111 This fork now compiles just fine on
 112         windows/mingw environment with Qt5.3.1 & GCC 4.8
 113         Ubuntuu 1404, 1510
 114         Mac OS X
 115
 116 ##Setup and build for UBUNTU
 117 GC made updates to allow this to build easily on Ubuntu 14.04.2 LTS or 15.10
 118 See https://github.com/Proxmark/proxmark3/wiki/Ubuntu%20Linux
 119
 120 Run
 121         -> sudo apt-get install p7zip git build-essential libreadline5 libreadline-dev libusb-0.1-4 libusb-dev libqt4-dev perl pkg-config wget
 122
 123 Follow these instructions
 124 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):
 125
 126 (64-bit) http://sourceforge.net/projects/devkitpro/files/devkitARM/previous/devkitARM_r41-x86_64-linux.tar.bz2/download
 127 (32-bit) http://sourceforge.net/projects/devkitpro/files/devkitARM/previous/devkitARM_r41-i686-linux.tar.bz2/download
 128
 129 Extract the contents of the .tar.bz2:
 130         ->  tar jxvf devkitARM_r41-<arch>-linux.tar.bz2
 131
 132 Create a directory for the arm dev kit:
 133         ->  sudo mkdir -p /opt/devkitpro/
 134
 135 Move the ARM developer kit to the newly created directory:
 136         -> sudo mv devkitARM /opt/devkitpro/
 137
 138 Add the appropriate environment variable:
 139         -> export PATH=${PATH}:/opt/devkitpro/devkitARM/bin/
 140
 141 Add the environment variable to your profile:
 142         -> echo 'PATH=${PATH}:/opt/devkitpro/devkitARM/bin/ ' >> ~/.bashrc
 143
 144 Clone iceman fork
 145         -> git clone https://github.com/iceman1001/proxmark3.git
 146
 147 Get the latest commits
 148         -> git pull
 149
 150 CLEAN COMPILE
 151         -> make clean && make all
 152
 153 Flash the BOOTROM
 154         -> client/flasher -b /dev/ttyACM0 bootrom/obj/bootrom.elf
 155
 156 Flash the FULLIMAGE
 157         -> client/flasher /dev/ttyACM0 armsrc/obj/fullimage.elf
 158
 159 Change into the client folder.
 160         -> cd client
 161
 162 Run the client
 163         -> ./proxmark3 /dev/ttyACM0
 164
 165 ##Homebrew (Mac OS X)
 166 ==================
 167 These instructions comes from @Chrisfu, where I got the proxmark3.rb scriptfile from.
 168 Further questions about Mac & Homebrew,  contact @Chrisfu
 169
 170 1. Install homebrew if you haven't yet already done so: http://brew.sh/
 171
 172 2. Tap this repo: `brew tap iceman1001/proxmark3`
 173
 174 3. Install Proxmark3: `brew install proxmark3` for stable release or `brew install --HEAD proxmark3` for latest non-stable from GitHub.
 175
 176 ##Docker container
 177 I recently added a docker container on Docker HUB.  You find it here: https://hub.docker.com/r/iceman1001/proxmark3/
 178 Follow those instructions to get it up and running.  No need for the old proxspace-environment anymore.
 179
 180 ## Enjoy
 181 -------------------
 182 January 2015, Sweden
 183 iceman at host iuse.se
 184
 185
 186
 187 BUYING A PROXMARK 3
 188 -------------------
 189
 190 The Proxmark 3 device is available for purchase (assembled and tested) from the following locations:
 191
 192    * http://www.elechouse.com  (new and revised hardware package 2015)
 193
 194    I recommend you to buy this version.
 195
 196 --------------------------------------------------------------------------
 197
 198 Most of the ultra-low-volume contract assemblers could put
 199 something like this together with a reasonable yield. A run of around
 200 a dozen units is probably cost-effective. The BOM includes (possibly-
 201 outdated) component pricing, and everything is available from Digikey
 202 and the usual distributors.
 203
 204 If you've never assembled a modern circuit board by hand, then this is
 205 not a good place to start. Some of the components (e.g. the crystals)
 206 must not be assembled with a soldering iron, and require hot air.
 207
 208 The schematics are included; the component values given are not
 209 necessarily correct for all situations, but it should be possible to do
 210 nearly anything you would want with appropriate population options.
 211
 212 The printed circuit board artwork is also available, as Gerbers and an
 213 Excellon drill file.
 214
 215
 216 LICENSING:
 217
 218 This program is free software; you can redistribute it and/or modify
 219 it under the terms of the GNU General Public License as published by
 220 the Free Software Foundation; either version 2 of the License, or
 221 (at your option) any later version.
 222
 223 This program is distributed in the hope that it will be useful,
 224 but WITHOUT ANY WARRANTY; without even the implied warranty of
 225 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 226 GNU General Public License for more details.
 227
 228 You should have received a copy of the GNU General Public License
 229 along with this program; if not, write to the Free Software
 230 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 231
 232
 233 Jonathan Westhues
 234 user jwesthues, at host cq.cx
 235
 236 May 2007, Cambridge MA