]> git.zerfleddert.de Git - proxmark3-svn/blob - README.md
textual (piwi)
[proxmark3-svn] / 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 (or bleeding edge)
6
7 ##Donate
8 https://paypal.me/iceman1001/
9 Feel free to donate. All support is welcome.
10
11 ##Notice
12 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.
13
14 ##Official
15 The official Proxmark repository is found here: https://github.com/Proxmark/proxmark3
16
17 ##Coverity Scan Config & Run
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 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.
34 Among the stuff is
35
36 * Jonor's hf 14a raw timing patch
37 * Piwi's updates. (usually gets into the master)
38 * Piwi's "topaz" branch
39 * Piwi's "hardnested" branch
40 * Holiman's iclass, (usually gets into the master)
41 * Marshmellow's fixes (usually gets into the master)
42 * Midnitesnake's Ultralight, Ultralight-c enhancements
43 * Izsh's lf peak modification / iir-filtering
44 * Aspers's tips and tricks from inside the PM3-gui-tool, settings.xml and other stuff.
45 * My own desfire, Ultralight extras, LF T55xx enhancements, bugs fixes (filelength, hf mf commands ), TNP3xxx lua scripts, Awid26, skidata scripts (will come)
46 * other obscure patches like for the sammy-mode, (offline you know), tagidentifications, defaultkeys.
47 * Minor textual changes here and there.
48 * Simulation of Ultralight/Ntag.
49 * Marshmellow's and my "RevEng" addon for the client. Ref: http://reveng.sourceforge.net/ Now using reveng1.44
50 * J-Run alternative bruteforce Mifare nested auths.. (you need one other exe to make it work)
51 * A Bruteforce for T55XX passwords against tag.
52 * A Bruteforce for AWID 26, starting w a facilitycode then trying all 0xFFFF cardnumbers via simulation. To be used against a AWID Reader.
53 * A Bruteforce for HID, starting w a facilitycode then trying all 0xFFFF cardnumbers via simulation. To be used against a HID Reader.
54 * Blaposts Crapto1 v3.3
55 * Icsom's legic script and legic enhancements
56 * Aczid's bitsliced bruteforce solver in 'hf mf hardnested'
57
58 ---
59 ##Why don't you merged with offical PM3 Master?
60 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.
61 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.
62
63 ##Why don't you add nnnn or mmmm functionality?
64 Give me a hint, and I'll see if I can't merge in the stuff you have.
65
66 ##PM3 GUI
67 I do tend to rename and move stuff around, the official PM3-GUI from Gaucho will not work so well. *sorry*
68
69 ##Development
70 This fork now compiles just fine on
71 - Windows/mingw environment with Qt5.6.1 & GCC 4.8
72 - Ubuntu 1404, 1510, 1604
73 - Mac OS X / Homebrew
74 - Docker container
75
76 ##Setup and build for UBUNTU
77 GC made updates to allow this to build easily on Ubuntu 14.04.2 LTS, 15.10 or 16.04
78 See https://github.com/Proxmark/proxmark3/wiki/Ubuntu%20Linux
79
80 A nice and cool install script made by @daveio is found here:
81 https://github.com/daveio/attacksurface/blob/master/proxmark3/pm3-setup.sh
82
83 - Run
84 `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`
85
86 - Clone iceman fork
87 `git clone https://github.com/iceman1001/proxmark3.git`
88
89 - Get the latest commits
90 `git pull`
91
92 - Install the blacklist rules
93 `make udev`
94
95 - 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.
96 `sudo adduser $USER dialout`
97
98 - Clean and complete compilation
99 `make clean && make all`
100
101 - Flash the BOOTROM
102 `client/flasher /dev/ttyACM0 -b bootrom/obj/bootrom.elf`
103
104 - Flash the FULLIMAGE
105 `client/flasher /dev/ttyACM0 armsrc/obj/fullimage.elf`
106
107 - Change into the client folder
108 `cd client`
109
110 - Run the client
111 `./proxmark3 /dev/ttyACM0`
112
113 ##Homebrew (Mac OS X)
114 These instructions comes from @Chrisfu, where I got the proxmark3.rb scriptfile from.
115 Further questions about Mac & Homebrew, contact @Chrisfu (https://github.com/chrisfu/)
116
117 1. Install homebrew if you haven't yet already done so: http://brew.sh/
118
119 2. Tap this repo: `brew tap iceman1001/proxmark3`
120
121 3. Install Proxmark3: `brew install proxmark3` for stable release or `brew install --HEAD proxmark3` for latest non-stable from GitHub.
122
123 ##Docker container
124 I recently added a docker container on Docker HUB. You find it here: https://hub.docker.com/r/iceman1001/proxmark3/
125 Follow those instructions to get it up and running. No need for the old proxspace-environment anymore.
126
127 [1.6.0] How to start: https://www.youtube.com/watch?v=b5Zta89Cf6Q
128 [1.6.0] How to connect: https://youtu.be/0ZS2t5C-caI
129 [1.6.1] How to flash: https://www.youtube.com/watch?v=WXouhuGYEiw
130
131 Recommendations: Use only latest container.
132
133
134 ## Building on Windows
135 ### 1. QT Open Source
136 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
137 Install to `C:\Qt` and choose the following components to be installed:
138 - QT - MinGW 32 bit
139 - Tools - MinGW
140
141 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:
142 `export QTDIR=/c/Qt/5.6/mingw49_32`
143 `export PATH=$PATH:$QTDIR/bin`
144
145 ### 2. MSYS
146 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.
147
148 Download MSYS: http://downloads.sourceforge.net/mingw/MSYS-1.0.11.exe
149
150 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`
151
152 ### 3. Readline
153 Download and unpack: https://sourceforge.net/projects/gnuwin32/files/readline/5.0-1/readline-5.0-1-bin.zip/download
154
155 `bin/*` to `C:\Qt\5.6\Tools\mingw492_32\bin`
156 `include/*` to `C:\Qt\5.6\Tools\mingw492_32\include`
157 `lib/*` to `C:\Qt\5.6\Tools\mingw492_32\lib`
158
159 ### 4. LibUSB
160 Download and unpack: https://sourceforge.net/projects/libusb-win32/files/latest/download?source=files
161
162 `include/lusb0_usb.h` to `C:\Qt\5.6\Tools\mingw492_32\include`
163 `lib/gcc/libusb.a` to `C:\Qt\5.6\Tools\mingw492_32\lib`
164
165 ### 5. DevkitPro
166 Download and install: https://sourceforge.net/projects/devkitpro/files/latest/download?source=files
167
168 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:
169 `export DEVKITARM=/c/devkitPro/devkitARM`
170 `export PATH=$PATH:$DEVKITARM/bin`
171
172 ### 6. Install Strawberry Perl
173 Download and install: https://storage.googleapis.com/google-code-archive-downloads/v2/code.google.com/strawberry-perl/strawberry-perl-5.10.1.3.msi
174
175 ### 7. Build and run
176 Download and install Git for Windows: https://git-scm.com/download/win
177
178 - Run minimal system: `C:\Qt\msys\msys.bat`
179
180 - Set the environment:
181 `export DEVKITARM=/c/devkitPro/devkitARM`
182 `export PATH=$PATH:$DEVKITARM/bin`
183 `export QTDIR=/c/Qt/5.6/mingw49_32`
184 `export PATH=$PATH:$QTDIR/bin`
185
186 - Clone iceman fork
187 `git clone https://github.com/iceman1001/proxmark3.git`
188
189 - Get the latest commits
190 `git pull`
191
192 - CLEAN COMPILE
193 `make clean && make all`
194
195 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.
196
197 - Flash the BOOTROM
198 `client/flasher.exe comX -b bootrom/obj/bootrom.elf`
199
200 - Flash the FULLIMAGE
201 `client/flasher.exe comX armsrc/obj/fullimage.elf`
202
203 - Change into the client folder
204 `cd client`
205
206 - Run the client
207 `proxmark3.exe comX`
208
209 ##Buying a proxmark3
210 The Proxmark 3 device is available for purchase (assembled and tested) from the following locations:
211
212 * http://proxmark3.tictail.com/ (For buyers in EU, most likely in Sweden)
213
214 * http://www.elechouse.com/ (new and revised hardware package 2015, located in China)
215
216
217 ##Enjoy
218
219 January 2015, Sweden
220 iceman at host iuse.se
221
222
223
224
225 ##Note from Jonathan Westhues
226 Most of the ultra-low-volume contract assemblers could put
227 something like this together with a reasonable yield. A run of around
228 a dozen units is probably cost-effective. The BOM includes (possibly-
229 outdated) component pricing, and everything is available from Digikey
230 and the usual distributors.
231
232 If you've never assembled a modern circuit board by hand, then this is
233 not a good place to start. Some of the components (e.g. the crystals)
234 must not be assembled with a soldering iron, and require hot air.
235
236 The schematics are included; the component values given are not
237 necessarily correct for all situations, but it should be possible to do
238 nearly anything you would want with appropriate population options.
239
240 The printed circuit board artwork is also available, as Gerbers and an
241 Excellon drill file.
242
243
244 LICENSING:
245
246 This program is free software; you can redistribute it and/or modify
247 it under the terms of the GNU General Public License as published by
248 the Free Software Foundation; either version 2 of the License, or
249 (at your option) any later version.
250
251 This program is distributed in the hope that it will be useful,
252 but WITHOUT ANY WARRANTY; without even the implied warranty of
253 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
254 GNU General Public License for more details.
255
256 You should have received a copy of the GNU General Public License
257 along with this program; if not, write to the Free Software
258 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
259
260
261 Jonathan Westhues
262 user jwesthues, at host cq.cx
263
264 May 2007, Cambridge MA
Impressum, Datenschutz