]> git.zerfleddert.de Git - proxmark3-svn/blobdiff - README.md
projects / proxmark3-svn / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
FIX: CoverityScan 133857, cast to uint32_t will stop eventual problems. However...
[proxmark3-svn] / README.md
diff --git a/README.md b/README.md
index 4416727d6f0b48b454168d88c4f5226e70a4897c..7f3b327d75ce2ef52e1c3ca538c14f455f50069a 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,26 +1,16 @@
 The iceman fork
 The iceman fork
----------------
-##::THIS FORK IS HIGHLY EXPERIMENTAL::
+===============
+[![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)
 
 
-##NOTICE:      
+##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.
 
 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 
+##Offical
 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: 
-
-## 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
-
+##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:
 
 Download the Coverity Scan Self-buld and install it.
 You will need to configure  ARM-NON-EABI- Compiler for it to use:
 
@@ -35,8 +25,7 @@ tar czvf proxmark3.tgz cov-int
 
 :: upload it to coverity.com
 
 
 :: upload it to coverity.com
 
-## Whats changed?
-
+##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
 
 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
 
@@ -60,13 +49,19 @@ Among the stuff is
        * 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
        * 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
-    * Azcid's bitsliced bruteforce solver in 'hf mf hardnested'
-
-
----    
-Straight from the CHANGELOG
----
+        * Icsom's  legic script and legic enhancements
+        * Aczid's bitsliced bruteforce solver in 'hf mf hardnested'
+
+##Straight from the CHANGELOG
+=============================
+  - 'analyse lcr' - added a new main command group,  to help analysing bytes & bits & nibbles. (iceman)
+  - 'lf nedap' - added identification of a NEDAP tag. (iceman)
+  - 'lf viking clone' - fixed a bug. (iceman)
+  - Added bitsliced bruteforce solver in 'hf mf hardnested' (aczid)
+  - 'hf mf chk' speedup (iceman)
+  - 'hf 14a/mf sim x" attack mode,  now uses also moebius version of mfkey32 to try finding the key. (iceman)
+  - 'hf 14a sim' Added emulation of Mifare cards with 10byte UID length. (iceman)
+  - 'hf mf sim' Added emulation of Mifare cards with 10byte UID length. (iceman)
   - 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)
   - 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)
@@ -96,27 +91,20 @@ Straight from the CHANGELOG
   - Fixed the silent mode for 14b to be used inside '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.
        
 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:
---------
+##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 now compiles just fine on 
 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
---------------------------
+   - Windows/mingw environment with Qt5.3.1 & GCC 4.8
+   - Ubuntuu 1404, 1510
+   - Mac OS X  (or before the hardnested BF solver at least)
 
 
+##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
 
 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
 
@@ -165,21 +153,47 @@ Change into the client folder.
 Run the client 
        -> ./proxmark3 /dev/ttyACM0
                                                   
 Run the client 
        -> ./proxmark3 /dev/ttyACM0
                                                   
+##Homebrew (Mac OS X)
+These instructions comes from @Chrisfu, where I got the proxmark3.rb scriptfile from.
+Further questions about Mac & Homebrew,  contact @Chrisfu  (https://github.com/chrisfu/)
 
 
-January 2015, Sweden
-iceman at host iuse.se
+1. Install homebrew if you haven't yet already done so: http://brew.sh/
+
+2. Tap this repo: `brew tap iceman1001/proxmark3`
+
+3. Install Proxmark3: `brew install proxmark3` for stable release or `brew install --HEAD proxmark3` for latest non-stable from GitHub.
+
+##Docker container
+I recently added a docker container on Docker HUB.  You find it here: https://hub.docker.com/r/iceman1001/proxmark3/
+Follow those instructions to get it up and running.  No need for the old proxspace-environment anymore.
 
 
-BUYING A PROXMARK 3
--------------------
+[1.6.0] How to start:   https://www.youtube.com/watch?v=b5Zta89Cf6Q
+[1.6.0] How to connect: https://youtu.be/0ZS2t5C-caI
+[1.6.1] How to flash:   https://www.youtube.com/watch?v=WXouhuGYEiw
 
 
+Recommendations:
+Use only container tag [1.6.1]
+
+
+##Buying a proxmark3
 The Proxmark 3 device is available for purchase (assembled and tested) from the following locations:
 
 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)  
+   * http://proxmark3.tictail.com/ (For buyers in EU, most likely in Sweden)
+ 
+   * http://www.elechouse.com/  (new and revised hardware package 2015, located in China)  
 
    I recommend you to buy this version. 
 
 
    I recommend you to buy this version. 
 
---------------------------------------------------------------------------
 
 
+##Enjoy
+
+January 2015, Sweden
+iceman at host iuse.se
+
+
+
+
+##Note from Jonathan Westhues
 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-
 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-
Proxmark3 GIT tracking
Impressum, Datenschutz