Merge branch 'master' of https://github.com/iceman1001/proxmark3

[proxmark3-svn] / README.md

diff --git a/README.md b/README.md
index 7f3b327d75ce2ef52e1c3ca538c14f455f50069a..94499d9b4c5fbdf2563bc09caa3589f3472dfa8a 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,29 +1,33 @@
 The iceman fork
 ===============
 The iceman fork
 ===============

-[![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)
+[![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)

 
 

-##This fork is HIGHLY experimental
+##This fork is HIGHLY experimental (or bleeding edge)
+
+##Donate
+https://paypal.me/iceman1001/
+Feel free to donate. All support is welcome.

 
 ##Notice      
 
 ##Notice      

-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.
+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. Which makes it so awesum to play with. Do please play with it. Get excited and experiment. As a side note with all coverity scan fixes this client is much more stable than PM3 Master even if I tend to break it sometimes. I'll try to make a release when this fork becomes stable between my experiments.

 
 

-##Offical
+##Official

 The official Proxmark repository is found here: https://github.com/Proxmark/proxmark3
 
 ##Coverity Scan Config & Run
 Download the Coverity Scan Self-buld and install it.
 You will need to configure  ARM-NON-EABI- Compiler for it to use:
 
 The official Proxmark repository is found here: https://github.com/Proxmark/proxmark3
 
 ##Coverity Scan Config & Run
 Download the Coverity Scan Self-buld and install it.
 You will need to configure  ARM-NON-EABI- Compiler for it to use:
 

-:: Configure
-cov-configure --comptype gcc --compiler  /opt/devkitpro/devkitARM/bin/arm-none-eabi-gcc
+- Configure
+`cov-configure --comptype gcc --compiler  /opt/devkitpro/devkitARM/bin/arm-none-eabi-gcc`

 
 

-::run it (I'm running on Ubuntu)
-cov-build --dir cov-int make all
+- run it (I'm running on Ubuntu)
+`cov-build --dir cov-int make all`

 
 

-:: make a tarball
-tar czvf proxmark3.tgz cov-int
+- make a tarball
+`tar czvf proxmark3.tgz cov-int`

 
 

-:: upload it to coverity.com
+- upload it to coverity.com

 
 ##Whats changed?
 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. 
 
 ##Whats changed?
 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. 


@@ -42,116 +46,69 @@ Among the stuff is
        * other obscure patches like for the sammy-mode,  (offline you know), tagidentifications, defaultkeys. 
        * Minor textual changes here and there.
        * Simulation of Ultralight/Ntag.
        * other obscure patches like for the sammy-mode,  (offline you know), tagidentifications, defaultkeys. 
        * Minor textual changes here and there.
        * Simulation of Ultralight/Ntag.

-       * Marshmellow's and my "RevEng" addon for the client.  Ref: http://reveng.sourceforge.net/    Now using reveng1.31
-       * Someone's alternative bruteforce Mifare changes.. (you need the two other exe to make it work)
-
+       * Marshmellow's and my "RevEng" addon for the client.  Ref: http://reveng.sourceforge.net/    Now using reveng1.44
+       * J-Run alternative bruteforce Mifare nested auths.. (you need one other exe to make it work)

        * A Bruteforce for T55XX passwords against tag.
        * A Bruteforce for AWID 26, starting w a facilitycode then trying all 0xFFFF cardnumbers via simulation. To be used against a AWID Reader.
        * A Bruteforce for HID,  starting w a facilitycode then trying all 0xFFFF cardnumbers via simulation. To be used against a HID Reader.
        * Blaposts Crapto1 v3.3
        * A Bruteforce for T55XX passwords against tag.
        * A Bruteforce for AWID 26, starting w a facilitycode then trying all 0xFFFF cardnumbers via simulation. To be used against a AWID Reader.
        * A Bruteforce for HID,  starting w a facilitycode then trying all 0xFFFF cardnumbers via simulation. To be used against a HID Reader.
        * Blaposts Crapto1 v3.3

-        * Icsom's  legic script and legic enhancements
-        * Aczid's bitsliced bruteforce solver in 'hf mf hardnested'
-
-##Straight from the CHANGELOG
-=============================
-  - 'analyse lcr' - added a new main command group,  to help analysing bytes & bits & nibbles. (iceman)
-  - 'lf nedap' - added identification of a NEDAP tag. (iceman)
-  - 'lf viking clone' - fixed a bug. (iceman)
-  - Added bitsliced bruteforce solver in 'hf mf hardnested' (aczid)
-  - 'hf mf chk' speedup (iceman)
-  - 'hf 14a/mf sim x" attack mode,  now uses also moebius version of mfkey32 to try finding the key. (iceman)
-  - 'hf 14a sim' Added emulation of Mifare cards with 10byte UID length. (iceman)
-  - 'hf mf sim' Added emulation of Mifare cards with 10byte UID length. (iceman)
-  - Added `lf guard clone/sim` (iceman)
-  - Added `lf pyramd clone/sim` (iceman) 
-  - trying to fix "hf 14b" command to be able to read CALYPSO card.     (iceman)
-  - `hf legic load`, it now loads faster and a casting bug is gone. (iceman)
-  - Added `hf legic calccrc8` added a method to calculate the legic crc-8 value (iceman)
-  - `hf legic decode` fixed the output overflow bugs, better printing (iceman)
-  - Coverity Scan fixes a lot of resource leaks, etc (iceman)
-  - Added `lf presco *` commands started (iceman) 
-  - Added `lf hid wiegand` added a method to calculate WIEGAND in different formats, (iceman)
-  - `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)
-  - `hf mf nested` better printing and added Adam Lauries "try to read Key B if Key A is found" (iceman)
-  - `hf mf mifare` fixing the zero parity path, which doesn't got called. (iceman) 
-  - Updated the @blapost's Crapto1 implementation to v3.3 (blapost) 
-  - `hf mf c*` updated the calling structure and refactored of the chinese magic commands (iceman, marshmellow)
-  - Started to add Peter Fillmore's  EMV fork into Iceman fork. ref: https://github.com/peterfillmore/proxmark3  (peter fillmore,  iceman)
-  - Added Travis-CI automatic build integration with GitHub fork. (iceman)
-  - Updated the Reveng 1.30 sourcecode to 1.31 from Reveng projecthomepage (iceman)
-  
-  - Added possibility to write direct to a Legic Prime Tag (MIM256/1024) without using values from the 'BigBuffer' -> 'hf legic writeRaw <addr> <value>' (icsom)
-  - Added possibility to decrease DCF values at address 0x05 & 0x06 on a Legic Prime Tag 
-               DCF-value will be pulled from the BigBuffer (address 0x05 & 0x06) so you have to 
-               load the data into the BigBuffer before with 'hf legic load <path/to/legic.dump>' & then
-               write the DCF-Values (both at once) with 'hf legic write 0x05 0x02'  (icsom)
-  - Added script `legic.lua` for display and edit Data of Legic-Prime Tags (icsom)
-  - Added the experimental HITAG_S support (spenneb)
-  - Added topaz detection to `hf search` (iceman)
-  - Fixed the silent mode for 14b to be used inside 'hf search' (iceman)
+    * Icsom's  legic script and legic enhancements
+    * Aczid's bitsliced bruteforce solver in 'hf mf hardnested'

        
 ---    
        
 ---    

-Give me a hint, and I'll see if I can't merge in the stuff you have. 
-
+##Why don't you merged with offical PM3 Master?

 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.
 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.

+Me fiddling with the code so much, there is a nightmare in merging a PR.  Luckily I have @marshmellow42 who takes some stuff and push PR's back.
+
+##Why don't you add nnnn or mmmm functionality?
+Give me a hint, and I'll see if I can't merge in the stuff you have. 

        
 ##PM3 GUI
 I do tend to rename and move stuff around, the official PM3-GUI from Gaucho will not work so well. *sorry*     
 
 ##Development
 This fork now compiles just fine on 
        
 ##PM3 GUI
 I do tend to rename and move stuff around, the official PM3-GUI from Gaucho will not work so well. *sorry*     
 
 ##Development
 This fork now compiles just fine on 

-   - Windows/mingw environment with Qt5.3.1 & GCC 4.8
-   - Ubuntuu 1404, 1510
-   - Mac OS X  (or before the hardnested BF solver at least)
+   - Windows/mingw environment with Qt5.6.1 & GCC 4.8
+   - Ubuntu 1404, 1510, 1604
+   - Mac OS X / Homebrew
+   - Docker container

 
 ##Setup and build for UBUNTU
 
 ##Setup and build for UBUNTU

-GC made updates to allow this to build easily on Ubuntu 14.04.2 LTS or 15.10
+GC made updates to allow this to build easily on Ubuntu 14.04.2 LTS, 15.10 or 16.04

 See https://github.com/Proxmark/proxmark3/wiki/Ubuntu%20Linux
 
 See https://github.com/Proxmark/proxmark3/wiki/Ubuntu%20Linux
 

-Run 
-       -> sudo apt-get install p7zip git build-essential libreadline5 libreadline-dev libusb-0.1-4 libusb-dev libqt4-dev perl pkg-config wget
-
-Follow these instructions
-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):
-
-(64-bit) http://sourceforge.net/projects/devkitpro/files/devkitARM/previous/devkitARM_r41-x86_64-linux.tar.bz2/download
-(32-bit) http://sourceforge.net/projects/devkitpro/files/devkitARM/previous/devkitARM_r41-i686-linux.tar.bz2/download
-
-Extract the contents of the .tar.bz2:
-       ->  tar jxvf devkitARM_r41-<arch>-linux.tar.bz2
+A nice and cool install script made by @daveio is found here: 
+https://github.com/daveio/attacksurface/blob/master/proxmark3/pm3-setup.sh

 
 

-Create a directory for the arm dev kit:
-       ->  sudo mkdir -p /opt/devkitpro/
+- Run          
+`sudo apt-get install p7zip git build-essential libreadline5 libreadline-dev libusb-0.1-4 libusb-dev libqt4-dev perl pkg-config wget libncurses5-dev gcc-arm-none-eabi`

 
 

-Move the ARM developer kit to the newly created directory:
-       -> sudo mv devkitARM /opt/devkitpro/
+- Clone iceman fork            
+`git clone https://github.com/iceman1001/proxmark3.git`

 
 

-Add the appropriate environment variable:
-       -> export PATH=${PATH}:/opt/devkitpro/devkitARM/bin/
+- Get the latest commits       
+`git pull`

 
 

-Add the environment variable to your profile:
-       -> echo 'PATH=${PATH}:/opt/devkitpro/devkitARM/bin/ ' >> ~/.bashrc
+- Install the blacklist rules  
+`make udev`

 
 

-Clone iceman fork
-       -> git clone https://github.com/iceman1001/proxmark3.git
+- add user to dialout group (if you on a Linux/ubuntu/debian). If you do this one, you need to logout and login in again to make sure your rights got changed. 
+`sudo adduser $USER dialout`

 
 

-Get the latest commits 
-       -> git pull
-
-CLEAN COMPILE  
-       -> make clean && make all
+- Clean and complete compilation       
+`make clean && make all`

        
        

-Flash the BOOTROM
-       -> client/flasher -b /dev/ttyACM0 bootrom/obj/bootrom.elf
+- Flash the BOOTROM            
+`client/flasher /dev/ttyACM0 -b bootrom/obj/bootrom.elf`

 
 

-Flash the FULLIMAGE    
-       -> client/flasher /dev/ttyACM0 armsrc/obj/fullimage.elf
+- Flash the FULLIMAGE  
+`client/flasher /dev/ttyACM0 armsrc/obj/fullimage.elf`

        
        

-Change into the client folder.         
-       -> cd client
+- Change into the client folder                
+`cd client`

        
        

-Run the client 
-       -> ./proxmark3 /dev/ttyACM0
+- Run the client       
+`./proxmark3 /dev/ttyACM0`

                                                   
 ##Homebrew (Mac OS X)
 These instructions comes from @Chrisfu, where I got the proxmark3.rb scriptfile from.
                                                   
 ##Homebrew (Mac OS X)
 These instructions comes from @Chrisfu, where I got the proxmark3.rb scriptfile from.


@@ -171,9 +128,83 @@ Follow those instructions to get it up and running.  No need for the old proxspa
 [1.6.0] How to connect: https://youtu.be/0ZS2t5C-caI
 [1.6.1] How to flash:   https://www.youtube.com/watch?v=WXouhuGYEiw
 
 [1.6.0] How to connect: https://youtu.be/0ZS2t5C-caI
 [1.6.1] How to flash:   https://www.youtube.com/watch?v=WXouhuGYEiw
 

-Recommendations:
-Use only container tag [1.6.1]
+Recommendations:  Use only latest container.
+
+
+## Building on Windows
+### 1. QT Open Source
+Download QT 5.6.1: http://download.qt.io/archive/qt/5.6/5.6.1-1/qt-opensource-windows-x86-mingw492-5.6.1-1.exe         
+Install to `C:\Qt` and choose the following components to be installed:                
+- QT - MinGW 32 bit
+- Tools - MinGW
+
+In your shell from MSYS (see below), make sure you set QTDIR to your QT installation and add its bin to your path as well:             
+`export QTDIR=/c/Qt/5.6/mingw49_32`            
+`export PATH=$PATH:$QTDIR/bin`
+
+### 2. MSYS
+MSYS is a collection of GNU utilities such as bash, make, gawk and grep to allow building of applications and programs which depend on traditionally UNIX tools to be present. It is intended to supplement MinGW and the deficiencies of the cmd shell.
+
+Download MSYS: http://downloads.sourceforge.net/mingw/MSYS-1.0.11.exe
+
+Follow the installation procedure, you may want to install MSYS to `C:\Qt\msys` and when asked where is your MinGW installation and for its path answer the following: `c:/Qt/Tools/mingw492_32`
+
+### 3. Readline
+Download and unpack: https://sourceforge.net/projects/gnuwin32/files/readline/5.0-1/readline-5.0-1-bin.zip/download            

 
 

+`bin/*` to `C:\Qt\5.6\Tools\mingw492_32\bin`           
+`include/*` to `C:\Qt\5.6\Tools\mingw492_32\include`           
+`lib/*` to `C:\Qt\5.6\Tools\mingw492_32\lib`
+
+### 4. LibUSB
+Download and unpack: https://sourceforge.net/projects/libusb-win32/files/latest/download?source=files
+
+`include/lusb0_usb.h` to `C:\Qt\5.6\Tools\mingw492_32\include`         
+`lib/gcc/libusb.a` to `C:\Qt\5.6\Tools\mingw492_32\lib`
+
+### 5. DevkitPro
+Download and install: https://sourceforge.net/projects/devkitpro/files/latest/download?source=files
+
+You only need devkitARM, nothing more (no extra lib or anything else) to compile the firmware (ARM) side. Assuming you installed it to `C:\devkitpro`, make sure you set the `DEVKITARM` environment variable to `/c/devkitPro/devkitARM` and add its bin to your PATH:                
+`export DEVKITARM=/c/devkitPro/devkitARM`              
+`export PATH=$PATH:$DEVKITARM/bin`
+
+### 6. Install Strawberry Perl
+Download and install: https://storage.googleapis.com/google-code-archive-downloads/v2/code.google.com/strawberry-perl/strawberry-perl-5.10.1.3.msi
+
+### 7. Build and run
+Download and install Git for Windows: https://git-scm.com/download/win
+
+- Run minimal system: `C:\Qt\msys\msys.bat`
+
+- Set the environment:         
+`export DEVKITARM=/c/devkitPro/devkitARM`              
+`export PATH=$PATH:$DEVKITARM/bin`             
+`export QTDIR=/c/Qt/5.6/mingw49_32`            
+`export PATH=$PATH:$QTDIR/bin`
+
+- Clone iceman fork            
+`git clone https://github.com/iceman1001/proxmark3.git`
+
+- Get the latest commits       
+`git pull`
+
+- CLEAN COMPILE                
+`make clean && make all`
+
+Assuming you have Proxmark3 Windows drivers installed you can run the Proxmark software where "X" is the com port number assigned to proxmark3 under Windows. 
+       
+- Flash the BOOTROM            
+`client/flasher.exe comX -b bootrom/obj/bootrom.elf`
+
+- Flash the FULLIMAGE  
+`client/flasher.exe comX armsrc/obj/fullimage.elf`
+       
+- Change into the client folder                
+`cd client`
+       
+- Run the client       
+`proxmark3.exe comX`

 
 ##Buying a proxmark3
 The Proxmark 3 device is available for purchase (assembled and tested) from the following locations:
 
 ##Buying a proxmark3
 The Proxmark 3 device is available for purchase (assembled and tested) from the following locations:


@@ -182,8 +213,6 @@ The Proxmark 3 device is available for purchase (assembled and tested) from the
  
    * http://www.elechouse.com/  (new and revised hardware package 2015, located in China)  
 
  
    * http://www.elechouse.com/  (new and revised hardware package 2015, located in China)  
 

-   I recommend you to buy this version. 
-

 
 ##Enjoy
 
 
 ##Enjoy