Add manpages for nfc-tools.

This commit is contained in:
Romuald Conty 2009-06-26 15:10:01 +00:00
parent 0da43b6731
commit bb4d79735a
5 changed files with 173 additions and 0 deletions

30
man/nfc-anticol.1 Normal file
View file

@ -0,0 +1,30 @@
.TH NFC-ANTICOL 1 "June 26, 2009"
.SH NAME
nfc-anticol \- Demonstration NFC anti-collison command line tool based on libnfc
.SH SYNOPSIS
.B nfc-anticol
.SH DESCRIPTION
.B nfc-anticol
is an anti-collision demonstration tool for ISO/IEC 14443-A tags, performed
by custom constructed frames. The first frame must be a short frame which
is only 7 bits long. Commercial SDK's often don't support a feature to send
frames that are not a multiple of 8 bits (1 byte) long.
This makes it impossible to do the anti-collision yourself.
The developer has to rely on closed proprietary software and should hope it does not contain vulnerabilities during the anti-collision phase.
Performing the anti-collision using custom frames could protect against a malicious tag that, for example, violates the standard by sending frames with unsupported lengths.
.SH BUGS
Please report any bugs on the
.B libnfc
forum at
.BR http://www.libnfc.org/community/ "."
.SH LICENCE
.B libnfc
and
.B nfc-tools
are covered by the GNU Lesser General Public License (LGPL), version 3.
.SH AUTHORS
Roel Verdult <roel@libnfc.org>
.PP
This manual page was written by Romuald Conty <romuald.conty@free.fr>.
It is licensed under the terms of the GNU GPL (version 2 or later).

31
man/nfc-emulate.1 Normal file
View file

@ -0,0 +1,31 @@
.TH NFC-EMULATE 1 "June 26, 2009"
.SH NAME
nfc-emulate \- NFC target emulation command line tool based on libnfc
.SH SYNOPSIS
.B nfc-emulate
.SH DESCRIPTION
.B nfc-emulate
is an tag emulatation tool. Tag emulation is one of the main added features in NFC.
To avoid abuse of existing systems, manufacturers of the NFC controller intentionally did not
support emulation of custom UID numbers.
The emulate tool demonstrates that this can still be done using transmission of raw-frames.
Fast communication is necessary to in time to respond during the anti-collision protocol.
Using the USB interface gives some timing issues but an embedded microprocessor could
be fast enough to emulate a tag with any UID. This makes it a serious thread
for security systems that rely only on the uniqueness of the UID.
.SH BUGS
Please report any bugs on the
.B libnfc
forum at
.BR http://www.libnfc.org/community/ "."
.SH LICENCE
.B libnfc
and
.B nfc-tools
are covered by the GNU Lesser General Public License (LGPL), version 3.
.SH AUTHORS
Roel Verdult <roel@libnfc.org>
.PP
This manual page was written by Romuald Conty <romuald.conty@free.fr>.
It is licensed under the terms of the GNU GPL (version 2 or later).

27
man/nfc-list.1 Normal file
View file

@ -0,0 +1,27 @@
.TH NFC-LIST 1 "June 26, 2009"
.SH NAME
nfc-list \- List NFC targets command line tool based on libnfc
.SH SYNOPSIS
.B nfc-list
.SH DESCRIPTION
.B nfc-list
utility attempts to select available tags in the field. The NFC
controller is used to perform the selection procedure. This is different for each modulation type.
It tries to find a ISO/IEC 14443 type A, type B, Felica or Jewel Topaz tags.
This tool demonstrates that it is possible to setup a simple NFC system using less than 10 lines of code.
.SH BUGS
Please report any bugs on the
.B libnfc
forum at
.BR http://www.libnfc.org/community/ "."
.SH LICENCE
.B libnfc
and
.B nfc-tools
are covered by the GNU Lesser General Public License (LGPL), version 3.
.SH AUTHORS
Roel Verdult <roel@libnfc.org>
.PP
This manual page was written by Romuald Conty <romuald.conty@free.fr>.
It is licensed under the terms of the GNU GPL (version 2 or later).

57
man/nfc-mftool.1 Normal file
View file

@ -0,0 +1,57 @@
.TH NFC-MFTOOL 1 "June 26, 2009"
.SH NAME
nfc-mftool \- Mifare Classic command line tool based on libnfc
.SH SYNOPSIS
.B nfc-mftool
.RI \fR\fBr\fR|\fBw\fR
.RI \fR\fBa\fR|\fBb\fR
.IR KEYS
.IR DUMP
.SH DESCRIPTION
.B nfc-mftool
is an Mifare Classic tool that allow to read or write
.IR DUMP
file using Mifare keys provide in
.IR KEYS
file.
The Mifare Classic tag is one of the most widely used RFID tags.
The firmware in the NFC controller supports authenticating, reading and writing to/from Mifare Classic tags.
This tool demonstrate the speed of this library and its easy-of-use.
It possible to read and write the complete content of a Mifare Classic 4KB tag within 1 second.
It uses a binary Mifare Dump File to store the keys and date for all sectors.
.SH OPTIONS
.BR r " | " w
Perform read from (
.B r
) or write to (
.B w
)card.
.TP
.BR a " | " b
Use A or B Mifare keys.
.TP
.IR KEYS
Mifare dump that contain Mifare keys.
.TP
.IR DUMP
Used to write card to file ( r ) or file to card ( w )
.SH BUGS
Please report any bugs on the
.B libnfc
forum at
.BR http://www.libnfc.org/community/ "."
.SH LICENCE
.B libnfc
and
.B nfc-tools
are covered by the GNU Lesser General Public License (LGPL), version 3.
.SH AUTHORS
Roel Verdult <roel@libnfc.org>
.PP
This manual page was written by Romuald Conty <romuald.conty@free.fr>.
It is licensed under the terms of the GNU GPL (version 2 or later).

28
man/nfc-relay.1 Normal file
View file

@ -0,0 +1,28 @@
.TH NFC-RELAY 1 "June 26, 2009"
.SH NAME
nfc-relay \- Relay attack command line tool based on libnfc
.SH SYNOPSIS
.B nfc-relay
.SH DESCRIPTION
.B nfc-relay
is an utility that demonstrates an relay attack. For this it requires two
NFC devices. One will emulate an ISO/IEC 14443 type A tag, while the 2nd
device will act as a reader. The genuine tag can be placed on the 2nd reader and
the tag emulator can be placed close to the original reader. All communication
is now relayed and shown in the screen on real-time.
.SH BUGS
Please report any bugs on the
.B libnfc
forum at
.BR http://www.libnfc.org/community/ "."
.SH LICENCE
.B libnfc
and
.B nfc-tools
are covered by the GNU Lesser General Public License (LGPL), version 3.
.SH AUTHORS
Roel Verdult <roel@libnfc.org>
.PP
This manual page was written by Romuald Conty <romuald.conty@free.fr>.
It is licensed under the terms of the GNU GPL (version 2 or later).