cvs.zerfleddert.de Git - proxmark3-svn/blob - README.md

   1 # proxmark3: the official Proxmark repository!
   2
   3 ## :warning: This repository has been archived. It is no longer maintained. Active development has moved over to [RRG Proxmark3 - Iceman Fork](https://github.com/RfidResearchGroup/proxmark3)
   4
   5 The proxmark3 is a powerful general purpose RFID tool, the size of a deck
   6 of cards, designed to snoop, listen and emulate everything from
   7 **Low Frequency (125kHz)** to **High Frequency (13.56MHz)** tags.
   8
   9 This repository contains enough software, logic (for the FPGA), and design
  10 documentation for the hardware that you could, at least in theory,
  11 do something useful with a proxmark3.
  12
  13 ## Resources
  14
  15 * [This repository!](https://github.com/Proxmark/proxmark3)
  16 * [The Wiki](https://github.com/Proxmark/proxmark3/wiki)
  17 * [The GitHub Pages website](http://proxmark.github.io/proxmark3/)
  18 * [The Forum](http://www.proxmark.org/forum)
  19 * The IRC channel: irc.freenode.org #proxmark3 ([chat in your browser](http://webchat.freenode.net/?channels=#proxmark3))
  20 * [The Homebrew formula repository](https://github.com/Proxmark/homebrew-proxmark3)
  21 * [Proxmark3 community discord server](https://discord.gg/86VcRtS)
  22
  23 ## Development
  24
  25 The tools required to build  or run the project will vary depending on
  26 your operating system. Please refer to [the wiki](https://github.com/Proxmark/proxmark3/wiki) for details.
  27
  28 ## Obtaining hardware
  29
  30 The Proxmark3 is available for purchase (assembled and tested) from the
  31 following locations:
  32
  33 | Distributor Name | Warehouse Location | Entity Location |
  34 |------------------|--------------------|-----------------|
  35 | [RyscCorp](https://proxmark3.com/)         | USA                | USA             |
  36 | [Hackerwarehouse](https://hackerwarehouse.com/)  | USA                | USA             |
  37 | [Elechouse](http://www.elechouse.com/)        | HK                 | HK              |
  38 | [Lab401](https://lab401.com/)           | EU                 | HK              |
  39 | [RFxSecure](http://www.rfxsecure.com/)       | CN                 | SG              |
  40 | [Sneaktechnology](https://www.sneaktechnology.com/)  | CN                 | CN              |
  41
  42
  43 Most of the ultra-low-volume contract assemblers could put
  44 something like this together with a reasonable yield. A run of around
  45 a dozen units is probably cost-effective. The BOM includes (possibly-
  46 outdated) component pricing, and everything is available from Digikey
  47 and the usual distributors.
  48
  49 If you've never assembled a modern circuit board by hand, then this is
  50 not a good place to start. Some of the components (e.g. the crystals)
  51 must not be assembled with a soldering iron, and require hot air.
  52
  53 The schematics are included; the component values given are not
  54 necessarily correct for all situations, but it should be possible to do
  55 nearly anything you would want with appropriate population options.
  56
  57 The printed circuit board artwork is also available, as Gerbers and an
  58 Excellon drill file.
  59
  60
  61 ## License
  62
  63 This program is free software; you can redistribute it and/or modify
  64 it under the terms of the GNU General Public License as published by
  65 the Free Software Foundation; either version 2 of the License, or
  66 (at your option) any later version.
  67
  68 This program is distributed in the hope that it will be useful,
  69 but WITHOUT ANY WARRANTY; without even the implied warranty of
  70 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  71 GNU General Public License for more details.
  72
  73 You should have received a copy of the GNU General Public License
  74 along with this program; if not, write to the Free Software
  75 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  76
  77
  78 Jonathan Westhues
  79 user jwesthues, at host cq.cx
  80
  81 May 2007, Cambridge MA