[proxmark3-svn] / README.md

The iceman fork
---------------
##::THIS FORK IS HIGHLY EXPERIMENTAL::

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


##OFFICAL 
The official Proxmark repository is found here: https://github.com/Proxmark/proxmark3

##NEWS: 

## Build Status Travis CI
[![Build Status](https://travis-ci.org/iceman1001/proxmark3.svg?branch=master)](https://travis-ci.org/iceman1001/proxmark3)

## Build Status Coverity Scan
[![Coverity Scan Build Status](https://scan.coverity.com/projects/5117/badge.svg)](https://scan.coverity.com/projects/proxmark3-iceman-fork)


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

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

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

:: 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. 
Among the stuff is

	* Jonor's hf 14a raw timing patch
	* Piwi's updates. (usually gets into the master)
	* Piwi's "topaz" branch
	* Piwi's "hardnested" branch 
	* Holiman's iclass, (usually gets into the master)
	* Marshmellow's fixes (usually gets into the master)
	* Midnitesnake's Ultralight,  Ultralight-c enhancements
	* Izsh's lf peak modification / iir-filtering
	* Aspers's tips and tricks from inside the PM3-gui-tool, settings.xml and other stuff.
	* My own desfire, Ultralight extras, LF T55xx enhancements, bugs fixes (filelength, hf mf commands ), TNP3xxx lua scripts,  Awid26,  skidata scripts (will come)
	* 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)

	* 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

---	
Straight from the CHANGELOG
---
  - 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)
	
---	
	
Give me a hint, and I'll see if I can't merge in the stuff you have. 

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

SETUP AND BUILD FOR UBUNTU
--------------------------

GC made updates to allow this to build easily on Ubuntu 14.04.2 LTS or 15.10
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

Create a directory for the arm dev kit:
	->  sudo mkdir -p /opt/devkitpro/

Move the ARM developer kit to the newly created directory:
	-> sudo mv devkitARM /opt/devkitpro/

Add the appropriate environment variable:
	-> export PATH=${PATH}:/opt/devkitpro/devkitARM/bin/

Add the environment variable to your profile:
	-> echo 'PATH=${PATH}:/opt/devkitpro/devkitARM/bin/ ' >> ~/.bashrc

Clone iceman fork
	-> git clone https://github.com/iceman1001/proxmark3.git

Get the latest commits	
	-> git pull

CLEAN COMPILE	
	-> make clean && make all
	
Flash the BOOTROM
	-> client/flasher -b /dev/ttyACM0 bootrom/obj/bootrom.elf

Flash the FULLIMAGE	
	-> client/flasher /dev/ttyACM0 armsrc/obj/fullimage.elf
	
Change into the client folder. 	
	-> cd client
	
Run the client	
	-> ./proxmark3 /dev/ttyACM0
						   

January 2015, Sweden
iceman at host iuse.se

BUYING A PROXMARK 3
-------------------

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

   * http://www.elechouse.com  (new and revised hardware package 2015)  

   I recommend you to buy this version. 

--------------------------------------------------------------------------

Most of the ultra-low-volume contract assemblers could put
something like this together with a reasonable yield. A run of around
a dozen units is probably cost-effective. The BOM includes (possibly-
outdated) component pricing, and everything is available from Digikey
and the usual distributors.

If you've never assembled a modern circuit board by hand, then this is
not a good place to start. Some of the components (e.g. the crystals)
must not be assembled with a soldering iron, and require hot air.

The schematics are included; the component values given are not
necessarily correct for all situations, but it should be possible to do
nearly anything you would want with appropriate population options.

The printed circuit board artwork is also available, as Gerbers and an
Excellon drill file.


LICENSING:

This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA


Jonathan Westhues
user jwesthues, at host cq.cx

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