VivoKey/vsmartcard
7
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 1 Wiki Activity

working on documentation

Browse Source
This commit is contained in:
Frank Morgner
2013-05-13 08:15:05 +02:00
parent ae8c086606
commit 54579ae7d7
25 changed files with 305 additions and 246 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
pcsc-relay/doc/Makefile.am
View File

@@ -16,7 +16,7 @@ do_subst = $(SED) \
-e 's,[@]abs_top_srcdir[@],$(abs_top_srcdir),g' \
-e 's,[@]top_srcdir[@],$(top_srcdir),g'
EXTRA_DIST = README.txt.in README.txt autotools.txt.in questions.txt.in autotools.txt questions.txt download.txt.in download.txt
EXTRA_DIST = README.txt.in README.txt autotools.txt.in questions.txt.in autotools.txt questions.txt download.txt.in download.txt relay-note.txt
doc: *.in
$(do_subst) < autotools.txt.in > autotools.txt

55
pcsc-relay/doc/README.txt
View File

@@ -2,13 +2,13 @@
.. _pcsc-relay:
###########
################################################################################
PC/SC Relay
###########
################################################################################
:Authors:
- Frank Morgner <morgner@informatik.hu-berlin.de>
- Dominik Oepen <oepen@informatik.hu-berlin.de>
- `Frank Morgner <morgner@informatik.hu-berlin.de>`_
- `Dominik Oepen <oepen@informatik.hu-berlin.de>`_
:License:
GPL version 3
:Tested Platforms:
@@ -19,21 +19,28 @@ PC/SC Relay
Welcome to PC/SC Relay. The purpose of PC/SC Relay is to relay a smart
card using an contact-less interface. Currently the following contact-less
backends:
backends are supported:
- libnfc_
- `Hardware supported by libnfc`_
- OpenPICC_
Command APDUs are received with the contact-less interface and forwarded to an
existing smart card via PC/SC. The Response APDUs are then sent back via RFID.
You can use PC/SC Relay in combination with the :ref:`vicc` to completely
emulate an ISO/IEC 14443 smart card.
Command APDUs are received with the contact-less interface and relayed. The
Response APDUs are then sent back via RFID. The contact-less data will be
relayed to one of the following:
.. note::
This software can actually be used in a relay attack allowing full access
to the card. We discussed the impact especially on the `Relay attack
against the German ID card`_, but it generally concerns *all* contact-less
smart cards.
- to a smart card inserted into one of the systems smart card readers. The
smart card reader must be accessible with PC/SC.
- to a :ref:`vicc` that directly connects to :command:`pcsc-relay`. The virtual
smart card's native interface is used and (despite its name) PC/SC Relay
does not need to access PC/SC in this case.
With PC/SC Relay you can relay a contact-less or contact based smart card
over a long distance. Also you can use it in combination with the :ref:`vicc`
to completely emulate an ISO/IEC 14443 smart card.
.. include:: relay-note.txt
.. include:: download.txt
@@ -50,19 +57,20 @@ PC/SC Relay has the following dependencies:
Hints on libnfc
===============
PC/SC Relay links against libnfc_. Here is an example of how to get the standard
installation of the latter::
Here is an example of how to get the standard
installation of libnfc::
PREFIX=/tmp/install
LIBNFC=libnfc
svn co http://libnfc.googlecode.com/svn/trunk $LIBNFC
git clone https://code.google.com/p/libnfc $LIBNFC
cd $LIBNFC
autoreconf -i
# See `./configure --help` for enabling support of additional hardware
./configure --prefix=$PREFIX
make
make install
Building PC/SC Relay with libnfc_ is done best using :command:`pkg-config`. The file
Building PC/SC Relay with libnfc is done best using :command:`pkg-config`. The file
:file:`libnfc.pc` should be located in ``$INSTALL/lib/pkgconfig``. Here is how to
configure PC/SC Relay to use it::
@@ -75,12 +83,13 @@ Hints on PC/SC middleware
A PC/SC middleware is included by default in most modern operating systems. On
Unix-like systems (Linux, OS X, Sun OS) it is realized by PCSC-Lite_. To
compile PC/SC Relay you will need to install the PCSC-Lite_ headers from
compile PC/SC Relay you will need to install the PCSC-Lite headers from
your distribution.
Windows also ships with a PC/SC middleware in form of the Winscard module.
Microsoft's developement environment Visual Studio includes all necessary data
for building PC/SC Relay.
PC/SC Relay can be (cross) compiled with MinGW-w64. Also, Microsoft's
developement environment Visual Studio includes all necessary data for building
PC/SC Relay.
*****
@@ -99,7 +108,7 @@ Notes and References
.. target-notes::
.. _`Hardware supported by libnfc`: http://nfc-tools.org/index.php?title=Devices_compatibility_matrix
.. _libnfc: http://www.libnfc.org/
.. _OpenPICC: http://www.openpcd.org/OpenPICC
.. _PCSC-lite: http://pcsclite.alioth.debian.org/
.. _`Relay attack against the German ID card`: http://media.ccc.de/browse/congress/2010/27c3-4297-de-die_gesamte_technik_ist_sicher.html

63
pcsc-relay/doc/README.txt.in
View File

@@ -2,13 +2,13 @@
.. _pcsc-relay:
###########
PC/SC Relay
###########
################################################################################
@PACKAGE_NAME@
################################################################################
:Authors:
- Frank Morgner <morgner@informatik.hu-berlin.de>
- Dominik Oepen <oepen@informatik.hu-berlin.de>
- `Frank Morgner <morgner@informatik.hu-berlin.de>`_
- `Dominik Oepen <oepen@informatik.hu-berlin.de>`_
:License:
GPL version 3
:Tested Platforms:
@@ -17,23 +17,30 @@ PC/SC Relay
:Potential Platforms:
Unix-like operating systems (Mac OS, Solaris, BSD, ...)
Welcome to PC/SC Relay. The purpose of PC/SC Relay is to relay a smart
Welcome to @PACKAGE_NAME@. The purpose of @PACKAGE_NAME@ is to relay a smart
card using an contact-less interface. Currently the following contact-less
backends:
backends are supported:
- libnfc_
- `Hardware supported by libnfc`_
- OpenPICC_
Command APDUs are received with the contact-less interface and forwarded to an
existing smart card via PC/SC. The Response APDUs are then sent back via RFID.
You can use PC/SC Relay in combination with the :ref:`vicc` to completely
emulate an ISO/IEC 14443 smart card.
Command APDUs are received with the contact-less interface and relayed. The
Response APDUs are then sent back via RFID. The contact-less data will be
relayed to one of the following:
.. note::
This software can actually be used in a relay attack allowing full access
to the card. We discussed the impact especially on the `Relay attack
against the German ID card`_, but it generally concerns *all* contact-less
smart cards.
- to a smart card inserted into one of the systems smart card readers. The
smart card reader must be accessible with PC/SC.
- to a :ref:`vicc` that directly connects to :command:`pcsc-relay`. The virtual
smart card's native interface is used and (despite its name) @PACKAGE_NAME@
does not need to access PC/SC in this case.
With @PACKAGE_NAME@ you can relay a contact-less or contact based smart card
over a long distance. Also you can use it in combination with the :ref:`vicc`
to completely emulate an ISO/IEC 14443 smart card.
.. include:: relay-note.txt
.. include:: download.txt
@@ -41,7 +48,7 @@ emulate an ISO/IEC 14443 smart card.
.. include:: autotools.txt
PC/SC Relay has the following dependencies:
@PACKAGE_NAME@ has the following dependencies:
- PC/SC middleware
- libnfc_
@@ -50,21 +57,22 @@ PC/SC Relay has the following dependencies:
Hints on libnfc
===============
PC/SC Relay links against libnfc_. Here is an example of how to get the standard
installation of the latter::
Here is an example of how to get the standard
installation of libnfc::
PREFIX=/tmp/install
LIBNFC=libnfc
svn co http://libnfc.googlecode.com/svn/trunk $LIBNFC
git clone https://code.google.com/p/libnfc $LIBNFC
cd $LIBNFC
autoreconf -i
# See `./configure --help` for enabling support of additional hardware
./configure --prefix=$PREFIX
make
make install
Building PC/SC Relay with libnfc_ is done best using :command:`pkg-config`. The file
Building @PACKAGE_NAME@ with libnfc is done best using :command:`pkg-config`. The file
:file:`libnfc.pc` should be located in ``$INSTALL/lib/pkgconfig``. Here is how to
configure PC/SC Relay to use it::
configure @PACKAGE_NAME@ to use it::
./configure PKG_CONFIG_PATH=$PREFIX/lib/pkgconfig
@@ -75,12 +83,13 @@ Hints on PC/SC middleware
A PC/SC middleware is included by default in most modern operating systems. On
Unix-like systems (Linux, OS X, Sun OS) it is realized by PCSC-Lite_. To
compile PC/SC Relay you will need to install the PCSC-Lite_ headers from
compile @PACKAGE_NAME@ you will need to install the PCSC-Lite headers from
your distribution.
Windows also ships with a PC/SC middleware in form of the Winscard module.
Microsoft's developement environment Visual Studio includes all necessary data
for building PC/SC Relay.
@PACKAGE_NAME@ can be (cross) compiled with MinGW-w64. Also, Microsoft's
developement environment Visual Studio includes all necessary data for building
@PACKAGE_NAME@.
*****
@@ -99,7 +108,7 @@ Notes and References
.. target-notes::
.. _`Hardware supported by libnfc`: http://nfc-tools.org/index.php?title=Devices_compatibility_matrix
.. _libnfc: http://www.libnfc.org/
.. _OpenPICC: http://www.openpcd.org/OpenPICC
.. _PCSC-lite: http://pcsclite.alioth.debian.org/
.. _`Relay attack against the German ID card`: http://media.ccc.de/browse/congress/2010/27c3-4297-de-die_gesamte_technik_ist_sicher.html

8
pcsc-relay/doc/autotools.txt
View File

@@ -5,10 +5,10 @@ Installation
************
The PC/SC Relay uses the GNU Build System to compile and install. If you are
unfamiliar with it, please have a look at :file:`INSTALL`. If you have a look
around and can not find it, you are probably working bleeding edge in the
repository. Run the following command in :file:`pcsc-relay` to
get the missing standard auxiliary files::
unfamiliar with it, please have a look at :file:`INSTALL`. If you can not find
it, you are probably working bleeding edge in the repository. Run the
following command in :file:`pcsc-relay` to get the missing standard
auxiliary files::
autoreconf --verbose --install

2
pcsc-relay/doc/download.txt
View File

@@ -4,7 +4,7 @@
Download
********
You can find the latest release of PC/SC Relay `here
You can find the latest release of PC/SC Relay on `Sourceforge
<http://sourceforge.net/projects/vsmartcard/files>`_.
Alternatively, you can clone our git repository::

6
pcsc-relay/doc/relay-note.txt Normal file
View File

@@ -0,0 +1,6 @@
.. note::
This software can actually be used in a relay attack allowing full access
to the card. We discussed the impact especially on the `Relay attack
against the German ID card
<http://media.ccc.de/browse/congress/2010/27c3-4297-de-die_gesamte_technik_ist_sicher.html>`_,
but it generally concerns *all* contact-less smart cards.