[proxmark3-svn] / README.md

The iceman fork
---------------

NOTICE: 

::THIS FORK IS HIGHLY EXPERIMENTAL::

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 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. 
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/
	* 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
	
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
	2	---------------
	3
	4	NOTICE:
	5
c0bab227	6	::THIS FORK IS HIGHLY EXPERIMENTAL::
c0bab227	7
02b6f355	8	The official Proxmark repository is found here: https://github.com/Proxmark/proxmark3
	9
	10	NEWS:
	11
02b6f355	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
b112787d	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)
c0bab227	28	cov-build --dir cov-int make all
b112787d	29
	30	:: make a tarball
	31	tar czvf proxmark3.tgz cov-int
	32
	33	:: upload it to coverity.com
	34
	35	## Whats changed?
	36
02b6f355	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.
c0bab227	58	* A Bruteforce for HID, starting w a facilitycode then trying all 0xFFFF cardnumbers via simulation. To be used against a HID Reader.
b112787d	59	* Blaposts Crapto1 v3.3
eb891c38	60
eb891c38	61	* icsom's legic script and legic enhancements
02b6f355	62
	63	Give me a hint, and I'll see if I can't merge in the stuff you have.
	64
	65	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.
	66
	67	PM3 GUI:
c0bab227	68	--------
02b6f355	69	I do tend to rename and move stuff around, the official PM3-GUI from Gaucho will not work so well. sorry
	70
	71
	72
	73	DEVELOPMENT:
c0bab227	74	------------
	75	This fork now compiles just fine on
	76	windows/mingw environment with Qt5.3.1 & GCC 4.8
	77	Ubuntuu 1404, 1510
	78	Mac OS X
	79
	80	SETUP AND BUILD FOR UBUNTU
	81	--------------------------
02b6f355	82
c0bab227	83	GC made updates to allow this to build easily on Ubuntu 14.04.2 LTS or 15.10
c0bab227	84	See https://github.com/Proxmark/proxmark3/wiki/Ubuntu%20Linux
02b6f355	85
c0bab227	86	Run
28d47dc9	87	-> sudo apt-get install p7zip git build-essential libreadline5 libreadline-dev libusb-0.1-4 libusb-dev libqt4-dev perl pkg-config wget
c0bab227	88
c0bab227	89	Follow these instructions
28d47dc9	90	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	91
	92	(64-bit) http://sourceforge.net/projects/devkitpro/files/devkitARM/previous/devkitARM_r41-x86_64-linux.tar.bz2/download
	93	(32-bit) http://sourceforge.net/projects/devkitpro/files/devkitARM/previous/devkitARM_r41-i686-linux.tar.bz2/download
c0bab227	94
02b6f355	95	Extract the contents of the .tar.bz2:
c0bab227	96	-> tar jxvf devkitARM_r41-<arch>-linux.tar.bz2
c0bab227	97
02b6f355	98	Create a directory for the arm dev kit:
c0bab227	99	-> sudo mkdir -p /opt/devkitpro/
c0bab227	100
02b6f355	101	Move the ARM developer kit to the newly created directory:
c0bab227	102	-> sudo mv devkitARM /opt/devkitpro/
c0bab227	103
02b6f355	104	Add the appropriate environment variable:
c0bab227	105	-> export PATH=${PATH}:/opt/devkitpro/devkitARM/bin/
c0bab227	106
02b6f355	107	Add the environment variable to your profile:
c0bab227	108	-> echo 'PATH=${PATH}:/opt/devkitpro/devkitARM/bin/ ' >> ~/.bashrc
	109
	110	Clone iceman fork
	111	-> git clone https://github.com/iceman1001/proxmark3.git
02b6f355	112
c0bab227	113	Get the latest commits
	114	-> git pull
	115
	116	CLEAN COMPILE
	117	-> make clean && make all
02b6f355	118
c0bab227	119	Flash the BOOTROM
	120	-> client/flasher -b /dev/ttyACM0 bootrom/obj/bootrom.elf
	121
	122	Flash the FULLIMAGE
	123	-> client/flasher /dev/ttyACM0 armsrc/obj/fullimage.elf
02b6f355	124
c0bab227	125	Change into the client folder.
c0bab227	126	-> cd client
02b6f355	127
c0bab227	128	Run the client
	129	-> ./proxmark3 /dev/ttyACM0
	130
02b6f355	131
	132	January 2015, Sweden
	133	iceman at host iuse.se
	134
c0bab227	135	BUYING A PROXMARK 3
	136	-------------------
	137
	138	The Proxmark 3 device is available for purchase (assembled and tested) from the following locations:
	139
	140	* http://www.elechouse.com (new and revised hardware package 2015)
02b6f355	141
c0bab227	142	I recommend you to buy this version.
02b6f355	143
c0bab227	144	--------------------------------------------------------------------------
02b6f355	145
	146	Most of the ultra-low-volume contract assemblers could put
	147	something like this together with a reasonable yield. A run of around
	148	a dozen units is probably cost-effective. The BOM includes (possibly-
	149	outdated) component pricing, and everything is available from Digikey
	150	and the usual distributors.
	151
	152	If you've never assembled a modern circuit board by hand, then this is
	153	not a good place to start. Some of the components (e.g. the crystals)
	154	must not be assembled with a soldering iron, and require hot air.
	155
	156	The schematics are included; the component values given are not
	157	necessarily correct for all situations, but it should be possible to do
	158	nearly anything you would want with appropriate population options.
	159
	160	The printed circuit board artwork is also available, as Gerbers and an
	161	Excellon drill file.
	162
	163
	164	LICENSING:
	165
	166	This program is free software; you can redistribute it and/or modify
	167	it under the terms of the GNU General Public License as published by
	168	the Free Software Foundation; either version 2 of the License, or
	169	(at your option) any later version.
	170
	171	This program is distributed in the hope that it will be useful,
	172	but WITHOUT ANY WARRANTY; without even the implied warranty of
	173	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	174	GNU General Public License for more details.
	175
	176	You should have received a copy of the GNU General Public License
	177	along with this program; if not, write to the Free Software
	178	Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
	179
	180
	181	Jonathan Westhues
	182	user jwesthues, at host cq.cx
	183
	184	May 2007, Cambridge MA