[proxmark3-svn] / README.md

# proxmark3: the official Proxmark repository!

The proxmark3 is a powerful general purpose RFID tool, the size of a deck
of cards, designed to snoop, listen and emulate everything from
**Low Frequency (125kHz)** to **High Frequency (13.56MHz)** tags.

This repository contains enough software, logic (for the FPGA), and design
documentation for the hardware that you could, at least in theory,
do something useful with a proxmark3.

## Resources

* [This repository!](https://github.com/Proxmark/proxmark3)
* [The Wiki](https://github.com/Proxmark/proxmark3/wiki)
* [The GitHub Pages website](http://proxmark.github.io/proxmark3/)
* [The Forum](http://www.proxmark.org/forum)
* The IRC channel: irc.freenode.org #proxmark3 ([chat in your browser](http://webchat.freenode.net/?channels=#proxmark3))
* [The Homebrew formula repository](https://github.com/Proxmark/homebrew-proxmark3)
   
## Development

The tools required to build  or run the project will vary depending on
your operating system. Please refer to [the wiki](https://github.com/Proxmark/proxmark3/wiki) for details.

## Obtaining hardware

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

* [RyscCorp](https://proxmark3.com/) (US)
* [Hackerwarehouse](https://hackerwarehouse.com/) (US)
* [Elechouse](http://www.elechouse.com/) (HK)
* [Lab401](https://lab401.com/) (FR)
* [RFxSecure](http://www.rfxsecure.com/) (SG)
* [IceSQL](http://proxmark3.tictail.com/) (SE)
   
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.


## License

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