Update README.md

[proxmark3-svn] / README.txt

diff --git a/README.txt b/README.txt
index 05829dac22cd2123610b2982daa3d4b4b6181e03..101ae88d2a04b23ad56ce82dee2f7240b226f9f0 100644 (file)
--- a/README.txt
+++ b/README.txt
@@ -1,24 +1,47 @@
-The iceman fork.
+The iceman fork
+---------------

 
 

-NOTICE:
+NOTICE: 

 
 The official Proxmark repository is found here: https://github.com/Proxmark/proxmark3
 
 
 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)

 
 

-NEWS:      

 
 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)
 
 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)
        * Holiman's iclass, (usually gets into the master)

-       * Marshmellow's LF fixes
+       * 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. 
        * 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
+    * 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. 
 
        
 Give me a hint, and I'll see if I can't merge in the stuff you have. 
 


@@ -28,17 +51,34 @@ PM3 GUI:
 
 I do tend to rename and move stuff around, the official PM3-GUI from Gaucho will not work so well. *sorry*     
 
 
 I do tend to rename and move stuff around, the official PM3-GUI from Gaucho will not work so well. *sorry*     
 

+

          
 DEVELOPMENT:
 
          
 DEVELOPMENT:
 

-This fork is adjusted to compile on windows/mingw environment with Qt5.3.1 & GCC 4.8
+This fork is adjusted to compile on windows/mingw environment with Qt5.3.1 & GCC 4.9

 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.
 
 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
+       - 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
+       - make all
+

 Common errors linux/macOS finds
 Common errors linux/macOS finds

-Error:
-       * loclass/fileutils.c:15:2: warning: implicit declaration of function ‘_stat’ [-Wimplicit-function-declaration]
-Solution:
-       * Remove the "unscore" sign.   In linux you use without underscore, in windows you need a underscore. 

        
 Error:  
        * \client\makefile  the parameter -lgdi32 
        
 Error:  
        * \client\makefile  the parameter -lgdi32 


@@ -61,8 +101,54 @@ Solution
        
 
 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.
        
 
 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:

 
 

-January 2015, Sweden
-iceman at host iuse.se
\ No newline at end of file
+   * 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