[proxmark3-svn] / README.md

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

NOTICE: 

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

NEWS: 

::THIS FORK IS HIGHLY EXPERIMENTAL::


## 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 UBUNTU_1404_QT4=1

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

	* Blaposts Crapto1 v3.3
	
	
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 is adjusted to compile on windows/mingw environment with Qt5.3.1 & GCC 4.8
For people with linux you will need to patch some source code and some small change to one makefile.  If you are lazy, you google the forum and find asper's or holimans makefile or you find your solution below.

GC made updates to allow this to build easily on Ubuntu 14.04.2 LTS.
	- See https://github.com/Proxmark/proxmark3/wiki/Ubuntu%20Linux
	- Generally speaking, if you're running a "later" Proxmark, installation is very easy.
	- Run "sudo apt-get install p7zip git build-essential libreadline5 libreadline-dev libusb-0.1-4 libusb-dev libqt4-dev perl pkg-config wget"a
	- 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
	- Use the magic build command "make UBUNTU_1404_QT4=1"

Common errors linux/macOS finds
	
Error:  
	* \client\makefile  the parameter -lgdi32 
Solution:
	* Remove parameter.
	
Error:  
	* Using older Qt4.6 gives compilation errors.  
Solution
	* Upgrade to Qt5.3.1 
	OR 
	* Change these two line in  \client\makefile
		CXXFLAGS = -I$(QTDIR)/include -I$(QTDIR)/include/QtCore -I$(QTDIR)/include/QtGui -I$(QTDIR)/include/QtWidgets  -I/mingw/include
		QTLDLIBS = -L$(QTDIR)/lib  -lQt5Core -lQt5Gui -lQt5Widgets 
		
		TO
		
		CXXFLAGS = -I$(QTDIR)/include -I$(QTDIR)/include/QtCore -I$(QTDIR)/include/QtGui
		QTLDLIBS = -L$(QTDIR)/lib -lQtCore4 -lQtGui4
	

An old Qt4 version makefile is found here: http://www.icesql.se/proxmark3/code/linuxmakefile.txt  but this one doesn't have all new files in it. So I don't recommend it.
							   

January 2015, Sweden
iceman at host iuse.se


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

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

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