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

respect sphinx style guide to some extent

Browse Source 
see http://documentation-style-guide-sphinx.readthedocs.org/en/latest/style-guide.html
This commit is contained in:
Frank Morgner
2013-03-05 20:42:09 +01:00
parent 9be74c7886
commit 37e5f9d514
74 changed files with 488 additions and 264 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
ccid/README
View File

@@ -1 +1 @@
doc/README.rst doc/README.txt

10
ccid/doc/Makefile.am
View File

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

51
ccid/doc/README.rst → ccid/doc/README.txt
View File

@@ -1,17 +1,13 @@
.. highlight:: sh .. highlight:: sh
.. _OpenSC: http://www.opensc-project.org/opensc
.. _GadgetFS: http://www.linux-usb.org/gadget/
.. _libccid: http://pcsclite.alioth.debian.org/ccid.html
.. |npa| replace:: :ref:`npa` .. |npa| replace:: :ref:`npa`
.. |PACE| replace:: :abbr:`PACE (Password Authenticated Connection Establishment)` .. |PACE| replace:: :abbr:`PACE (Password Authenticated Connection Establishment)`
.. _ccid-emulator: .. _ccid-emulator:
******************************************************************************** #################
USB CCID Emulator USB CCID Emulator
******************************************************************************** #################
:Author: :Author:
Frank Morgner <morgner@informatik.hu-berlin.de> Frank Morgner <morgner@informatik.hu-berlin.de>
@@ -46,17 +42,15 @@ USB CCID PC/SC
================================== ============================================================ ================================== ============================================================
The USB CCID Emulator is implemented using GadgetFS_. Some fragments of the source The USB CCID Emulator is implemented using GadgetFS_. Some fragments of the source
code are based on the GadgetFS example and on the source code of the OpenSC_ code are based on the GadgetFS example and on the source code of the OpenSC
tools. tools.
.. [#f1] Note that the heavily outdated `Windows USB CCID driver <http://msdn.microsoft.com/en-us/windows/hardware/gg487509>`_ does not support secure PIN entry or PIN modification. USB CCID Emulator comes with a patch for libccid_ to support |PACE|, because it is not yet standardised in USB CCID. However, the traditional commands can be used without restriction.
.. include:: download.txt
.. include:: download.rst .. include:: autotools.txt
.. include:: autotools.rst
Running the USB CCID Emulator has the following dependencies: Running the USB CCID Emulator has the following dependencies:
@@ -69,13 +63,13 @@ needs a usable PC/SC middleware with USB CCID driver. This is the case for most
modern Windows and Unix-like systems by default. modern Windows and Unix-like systems by default.
----------------- =================
Hints on GadgetFS Hints on GadgetFS
----------------- =================
To create a USB Gadget in both USB host and USB client mode, you need to load To create a USB Gadget in both USB host and USB client mode, you need to load
the kernel module :program:`gadgetfs`. A guide focused on Debian based systems the kernel module :program:`gadgetfs`. A guide focused on Debian based systems
to run and compile GadgetFS_, you can find `here to run and compile GadgetFS, you can find in the `OpenMoko Wiki
<http://wiki.openmoko.org/wiki/Building_Gadget_USB_Module>`_. <http://wiki.openmoko.org/wiki/Building_Gadget_USB_Module>`_.
On OpenMoko it is likely that you need to `patch your kernel On OpenMoko it is likely that you need to `patch your kernel
@@ -88,14 +82,14 @@ loading the module, you maybe want to check out `this patch
<http://comments.gmane.org/gmane.linux.usb.general/47440>`_. <http://comments.gmane.org/gmane.linux.usb.general/47440>`_.
--------------- ===============
Hints on OpenSC Hints on OpenSC
--------------- ===============
Without the |npa| the USB CCID Emulator links against OpenSC, which is discouraged Without the |npa| the USB CCID Emulator links against OpenSC, which is discouraged
and hindered since OpenSC version >= 0.12. You need the OpenSC components to be and hindered since OpenSC version >= 0.12. You need the OpenSC components to be
installed (especially :file:`libopensc.so`). Here is an example of how to get installed (especially :file:`libopensc.so`). Here is an example of how to get
the standard installation of OpenSC_ without |PACE|:: the standard installation of OpenSC without |PACE|::
PREFIX=/tmp/install PREFIX=/tmp/install
OPENSC=opensc OPENSC=opensc
@@ -112,12 +106,12 @@ configure the USB CCID Emulator to use it::
./configure OPENSC_LIBS="-L$PREFIX/lib -lopensc" ./configure OPENSC_LIBS="-L$PREFIX/lib -lopensc"
===== *****
Usage Usage
===== *****
The USB CCID Emulator has various command line options to customize the appearance The USB CCID Emulator has various command line options to customize the appearance
on the USB host. In order to run the USB CCID Emulator GadgetFS_ must be loaded on the USB host. In order to run the USB CCID Emulator GadgetFS must be loaded
and mounted. The USB CCID Emulator is compatible with the unix driver libccid_ and mounted. The USB CCID Emulator is compatible with the unix driver libccid_
and the `Windows USB CCID driver and the `Windows USB CCID driver
<http://msdn.microsoft.com/en-us/windows/hardware/gg487509>`_. To initialize <http://msdn.microsoft.com/en-us/windows/hardware/gg487509>`_. To initialize
@@ -126,4 +120,17 @@ and the `Windows USB CCID driver
.. program-output:: ccid-emulator --help .. program-output:: ccid-emulator --help
.. include:: questions.rst .. include:: questions.txt
********************
Notes and References
********************
.. target-notes::
.. [#f1] Note that the heavily outdated `Windows USB CCID driver`_ does not support secure PIN entry or PIN modification. USB CCID Emulator comes with a patch for libccid_ to support |PACE|, because it is not yet standardised in USB CCID. However, the traditional commands can be used without restriction.
.. _`Windows USB CCID driver`: http://msdn.microsoft.com/en-us/windows/hardware/gg487509
.. _`OpenSC`: http://www.opensc-project.org/opensc
.. _`GadgetFS`: http://www.linux-usb.org/gadget/
.. _`libccid`: http://pcsclite.alioth.debian.org/ccid.html

79
ccid/doc/README.rst.in → ccid/doc/README.txt.in
View File

@@ -1,17 +1,13 @@
.. highlight:: sh .. highlight:: sh
.. _OpenSC: http://www.opensc-project.org/opensc
.. _GadgetFS: http://www.linux-usb.org/gadget/
.. _libccid: http://pcsclite.alioth.debian.org/ccid.html
.. |npa| replace:: :ref:`npa` .. |npa| replace:: :ref:`npa`
.. |PACE| replace:: :abbr:`PACE (Password Authenticated Connection Establishment)` .. |PACE| replace:: :abbr:`PACE (Password Authenticated Connection Establishment)`
.. _ccid-emulator: .. _ccid-emulator:
******************************************************************************** #################
@PACKAGE_NAME@ USB CCID Emulator
******************************************************************************** #################
:Author: :Author:
Frank Morgner <morgner@informatik.hu-berlin.de> Frank Morgner <morgner@informatik.hu-berlin.de>
@@ -20,21 +16,21 @@
:Tested Platforms: :Tested Platforms:
Linux (Debian, Ubuntu, OpenMoko) Linux (Debian, Ubuntu, OpenMoko)
The @PACKAGE_NAME@ forwards a locally present PC/SC smart card reader as a The USB CCID Emulator forwards a locally present PC/SC smart card reader as a
standard USB CCID reader. @PACKAGE_NAME@ can be used as trusted intermediary standard USB CCID reader. USB CCID Emulator can be used as trusted intermediary
enabling secure PIN entry and PIN modification. In combination with the |npa| enabling secure PIN entry and PIN modification. In combination with the |npa|
also |PACE| can be performed by the emulator. also |PACE| can be performed by the emulator.
If the machine running :command:`@PACKAGE@` is in USB device mode, a local If the machine running :command:`ccid-emulator` is in USB device mode, a local
reader is forwareded via USB to another machine. If in USB host mode, the USB reader is forwareded via USB to another machine. If in USB host mode, the USB
CCID reader will locally be present. CCID reader will locally be present.
Applications on Windows and Unix-like systems can access the @PACKAGE_NAME@ Applications on Windows and Unix-like systems can access the USB CCID Emulator
through PC/SC as if it was a real smart card reader. No installation of a smart through PC/SC as if it was a real smart card reader. No installation of a smart
card driver is required since USB CCID drivers are usually shipped with the card driver is required since USB CCID drivers are usually shipped with the
modern OS. [#f1]_ modern OS. [#f1]_
Here is a subset of USB CCID commands supported by the @PACKAGE_NAME@ with Here is a subset of USB CCID commands supported by the USB CCID Emulator with
their PC/SC counterpart: their PC/SC counterpart:
================================== ============================================================ ================================== ============================================================
@@ -45,37 +41,35 @@ USB CCID PC/SC
``PC_to_RDR_Secure`` (proprietary) ``FEATURE_EXECUTE_PACE`` ``PC_to_RDR_Secure`` (proprietary) ``FEATURE_EXECUTE_PACE``
================================== ============================================================ ================================== ============================================================
The @PACKAGE_NAME@ is implemented using GadgetFS_. Some fragments of the source The USB CCID Emulator is implemented using GadgetFS_. Some fragments of the source
code are based on the GadgetFS example and on the source code of the OpenSC_ code are based on the GadgetFS example and on the source code of the OpenSC
tools. tools.
.. [#f1] Note that the heavily outdated `Windows USB CCID driver <http://msdn.microsoft.com/en-us/windows/hardware/gg487509>`_ does not support secure PIN entry or PIN modification. @PACKAGE_NAME@ comes with a patch for libccid_ to support |PACE|, because it is not yet standardised in USB CCID. However, the traditional commands can be used without restriction.
.. include:: download.txt
.. include:: download.rst .. include:: autotools.txt
Running the USB CCID Emulator has the following dependencies:
.. include:: autotools.rst
Running the @PACKAGE_NAME@ has the following dependencies:
- Linux Kernel with GadgetFS_ - Linux Kernel with GadgetFS_
- OpenSC_ - OpenSC_
- |npa| (only if support for |PACE| is enabled) - |npa| (only if support for |PACE| is enabled)
Whereas using the @PACKAGE_NAME@ on the host system as smart card reader only Whereas using the USB CCID Emulator on the host system as smart card reader only
needs a usable PC/SC middleware with USB CCID driver. This is the case for most needs a usable PC/SC middleware with USB CCID driver. This is the case for most
modern Windows and Unix-like systems by default. modern Windows and Unix-like systems by default.
----------------- =================
Hints on GadgetFS Hints on GadgetFS
----------------- =================
To create a USB Gadget in both USB host and USB client mode, you need to load To create a USB Gadget in both USB host and USB client mode, you need to load
the kernel module :program:`gadgetfs`. A guide focused on Debian based systems the kernel module :program:`gadgetfs`. A guide focused on Debian based systems
to run and compile GadgetFS_, you can find `here to run and compile GadgetFS, you can find in the `OpenMoko Wiki
<http://wiki.openmoko.org/wiki/Building_Gadget_USB_Module>`_. <http://wiki.openmoko.org/wiki/Building_Gadget_USB_Module>`_.
On OpenMoko it is likely that you need to `patch your kernel On OpenMoko it is likely that you need to `patch your kernel
@@ -88,14 +82,14 @@ loading the module, you maybe want to check out `this patch
<http://comments.gmane.org/gmane.linux.usb.general/47440>`_. <http://comments.gmane.org/gmane.linux.usb.general/47440>`_.
--------------- ===============
Hints on OpenSC Hints on OpenSC
--------------- ===============
Without the |npa| the @PACKAGE_NAME@ links against OpenSC, which is discouraged Without the |npa| the USB CCID Emulator links against OpenSC, which is discouraged
and hindered since OpenSC version >= 0.12. You need the OpenSC components to be and hindered since OpenSC version >= 0.12. You need the OpenSC components to be
installed (especially :file:`libopensc.so`). Here is an example of how to get installed (especially :file:`libopensc.so`). Here is an example of how to get
the standard installation of OpenSC_ without |PACE|:: the standard installation of OpenSC without |PACE|::
PREFIX=/tmp/install PREFIX=/tmp/install
OPENSC=opensc OPENSC=opensc
@@ -107,23 +101,36 @@ the standard installation of OpenSC_ without |PACE|::
make install make install
Now :file:`libopensc.so` should be located in ``$PREFIX/lib``. Here is how to Now :file:`libopensc.so` should be located in ``$PREFIX/lib``. Here is how to
configure the @PACKAGE_NAME@ to use it:: configure the USB CCID Emulator to use it::
./configure OPENSC_LIBS="-L$PREFIX/lib -lopensc" ./configure OPENSC_LIBS="-L$PREFIX/lib -lopensc"
===== *****
Usage Usage
===== *****
The @PACKAGE_NAME@ has various command line options to customize the appearance The USB CCID Emulator has various command line options to customize the appearance
on the USB host. In order to run the @PACKAGE_NAME@ GadgetFS_ must be loaded on the USB host. In order to run the USB CCID Emulator GadgetFS must be loaded
and mounted. The @PACKAGE_NAME@ is compatible with the unix driver libccid_ and mounted. The USB CCID Emulator is compatible with the unix driver libccid_
and the `Windows USB CCID driver and the `Windows USB CCID driver
<http://msdn.microsoft.com/en-us/windows/hardware/gg487509>`_. To initialize <http://msdn.microsoft.com/en-us/windows/hardware/gg487509>`_. To initialize
|PACE| using the PC/SC API you need to patch libccid_ (see :file:`patches`). |PACE| using the PC/SC API you need to patch libccid_ (see :file:`patches`).
.. program-output:: @PACKAGE@ --help .. program-output:: ccid-emulator --help
.. include:: questions.rst .. include:: questions.txt
********************
Notes and References
********************
.. target-notes::
.. [#f1] Note that the heavily outdated `Windows USB CCID driver`_ does not support secure PIN entry or PIN modification. USB CCID Emulator comes with a patch for libccid_ to support |PACE|, because it is not yet standardised in USB CCID. However, the traditional commands can be used without restriction.
.. _`Windows USB CCID driver`: http://msdn.microsoft.com/en-us/windows/hardware/gg487509
.. _`OpenSC`: http://www.opensc-project.org/opensc
.. _`GadgetFS`: http://www.linux-usb.org/gadget/
.. _`libccid`: http://pcsclite.alioth.debian.org/ccid.html

1
ccid/doc/autotools.rst.in
View File

@@ -1 +0,0 @@
../../doc/autotools.rst.in

4
ccid/doc/autotools.rst → ccid/doc/autotools.txt
View File

@@ -1,8 +1,8 @@
.. highlight:: sh .. highlight:: sh
============ ************
Installation Installation
============ ************
The USB CCID Emulator uses the GNU Build System to compile and install. If you are The USB CCID Emulator 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 unfamiliar with it, please have a look at :file:`INSTALL`. If you have a look

1
ccid/doc/autotools.txt.in Symbolic link
View File

@@ -0,0 +1 @@
../../doc/autotools.txt.in

1
ccid/doc/download.rst.in
View File

@@ -1 +0,0 @@
../../doc/download.rst.in

12
ccid/doc/download.txt Normal file
View File

@@ -0,0 +1,12 @@
.. highlight:: sh
********
Download
********
You can find the latest release of USB CCID Emulator `here
<http://sourceforge.net/projects/vsmartcard/files>`_.
Alternatively, you can clone our git repository::
git clone git://vsmartcard.git.sourceforge.net/gitroot/vsmartcard/vsmartcard

1
ccid/doc/download.txt.in Symbolic link
View File

@@ -0,0 +1 @@
../../doc/download.txt.in

1
ccid/doc/questions.rst.in
View File

@@ -1 +0,0 @@
../../doc/questions.rst.in

4
ccid/doc/questions.rst → ccid/doc/questions.txt
View File

@@ -1,6 +1,6 @@
======== ********
Question Question
======== ********
Do you have questions, suggestions or contributions? Feedback of any kind is Do you have questions, suggestions or contributions? Feedback of any kind is
more than welcome! Please use our `project trackers <http://sourceforge.net/projects/vsmartcard/support>`_. more than welcome! Please use our `project trackers <http://sourceforge.net/projects/vsmartcard/support>`_.

1
ccid/doc/questions.txt.in Symbolic link
View File

@@ -0,0 +1 @@
../../doc/questions.txt.in

4
doc/autotools.rst.in → doc/autotools.txt.in
View File

@@ -1,8 +1,8 @@
.. highlight:: sh .. highlight:: sh
============ ************
Installation Installation
============ ************
The @PACKAGE_NAME@ uses the GNU Build System to compile and install. If you are The @PACKAGE_NAME@ 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 unfamiliar with it, please have a look at :file:`INSTALL`. If you have a look

4
doc/conf.py
View File

@@ -41,7 +41,7 @@ extensions = ["breathe", "sphinxcontrib.doxylink", "sphinx.ext.autosummary", "sp
templates_path = ['_templates'] templates_path = ['_templates']
# The suffix of source filenames. # The suffix of source filenames.
source_suffix = '.rst' source_suffix = '.txt'
# The encoding of source files. # The encoding of source files.
#source_encoding = 'utf-8-sig' #source_encoding = 'utf-8-sig'
@@ -74,7 +74,7 @@ release = '2012-04-11'
# List of patterns, relative to source directory, that match files and # List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files. # directories to ignore when looking for source files.
exclude_patterns = ['_build', '*/questions.rst', '*/autotools.rst', '*/download.rst'] exclude_patterns = ['_build', '*/questions.txt', '*/autotools.txt', '*/download.txt']
# The reST default role (used for this markup: `text`) to use for all documents. # The reST default role (used for this markup: `text`) to use for all documents.
#default_role = None #default_role = None

4
doc/download.rst.in → doc/download.txt.in
View File

@@ -1,8 +1,8 @@
.. highlight:: sh .. highlight:: sh
=============================================================================== ********
Download Download
=============================================================================== ********
You can find the latest release of @PACKAGE_NAME@ `here You can find the latest release of @PACKAGE_NAME@ `here
<http://sourceforge.net/projects/vsmartcard/files>`_. <http://sourceforge.net/projects/vsmartcard/files>`_.

0
doc/index.rst → doc/index.txt
View File

4
doc/questions.rst.in → doc/questions.txt.in
View File

@@ -1,6 +1,6 @@
======== ********
Question Question
======== ********
Do you have questions, suggestions or contributions? Feedback of any kind is Do you have questions, suggestions or contributions? Feedback of any kind is
more than welcome! Please use our `project trackers <@PACKAGE_BUGREPORT@>`_. more than welcome! Please use our `project trackers <@PACKAGE_BUGREPORT@>`_.

2
npa/README
View File

@@ -1 +1 @@
doc/README.rst doc/README.txt

12
npa/doc/Makefile.am
View File

@@ -16,18 +16,18 @@ do_subst = $(SED) \
-e 's,[@]abs_top_srcdir[@],$(abs_top_srcdir),g' \ -e 's,[@]abs_top_srcdir[@],$(abs_top_srcdir),g' \
-e 's,[@]top_srcdir[@],$(top_srcdir),g' -e 's,[@]top_srcdir[@],$(top_srcdir),g'
EXTRA_DIST = README.rst.in README.rst Doxyfile.in example.c autotools.rst autotools.rst.in questions.rst questions.rst.in download.rst.in download.rst EXTRA_DIST = README.txt.in README.txt Doxyfile.in example.c autotools.txt autotools.txt.in questions.txt questions.txt.in download.txt.in download.txt
DOXYGEN = doxygen DOXYGEN = doxygen
doc: $(top_srcdir)/src/npa/*.h *.in doc: $(top_srcdir)/src/npa/*.h *.in
$(do_subst) < Doxyfile.in > Doxyfile $(do_subst) < Doxyfile.in > Doxyfile
$(DOXYGEN) Doxyfile $(DOXYGEN) Doxyfile
touch api.rst touch api.txt
$(do_subst) < autotools.rst.in > autotools.rst $(do_subst) < autotools.txt.in > autotools.txt
$(do_subst) < questions.rst.in > questions.rst $(do_subst) < questions.txt.in > questions.txt
$(do_subst) < download.rst.in > download.rst $(do_subst) < download.txt.in > download.txt
$(do_subst) < README.rst.in > README.rst $(do_subst) < README.txt.in > README.txt
touch doc touch doc
clean-local: clean-local:

43
npa/doc/README.rst → npa/doc/README.txt
View File

@@ -1,18 +1,14 @@
.. highlight:: sh .. highlight:: sh
.. _OpenSC: https://github.com/OpenSC/OpenSC
.. _OpenSSL: http://www.openssl.org
.. _OpenPACE: http://openpace.sourceforge.net
.. |PACE| replace:: :abbr:`PACE (Password Authenticated Connection Establishment)` .. |PACE| replace:: :abbr:`PACE (Password Authenticated Connection Establishment)`
.. |npa-tool| replace:: :command:`npa-tool` .. |npa-tool| replace:: :command:`npa-tool`
.. _npa: .. _npa:
******************************************************************************** ######################
nPA Smart Card Library nPA Smart Card Library
******************************************************************************** ######################
:Author: :Author:
Frank Morgner <morgner@informatik.hu-berlin.de> Frank Morgner <morgner@informatik.hu-berlin.de>
@@ -35,12 +31,12 @@ transparent SM usage in OpenSC. This allows nPA Smart Card Library to be fully
compatible with OpenSC. compatible with OpenSC.
.. include:: download.rst .. include:: download.txt
.. _npa-install: .. _npa-install:
.. include:: autotools.rst .. include:: autotools.txt
The nPA Smart Card Library has the following dependencies: The nPA Smart Card Library has the following dependencies:
@@ -49,9 +45,9 @@ The nPA Smart Card Library has the following dependencies:
- OpenSC_ - OpenSC_
------------------------------------ ====================================
Installation of OpenPACE and OpenSSL Installation of OpenPACE and OpenSSL
------------------------------------ ====================================
The nPA Smart Card Library links against OpenSSL_, which must be patched for OpenPACE_. The nPA Smart Card Library links against OpenSSL_, which must be patched for OpenPACE_.
Here is an example of how to get the standard installation of OpenPACE_ (with Here is an example of how to get the standard installation of OpenPACE_ (with
@@ -69,13 +65,13 @@ the required binaries for OpenSSL)::
The file :file:`libcrypto.pc` should be located in ``$INSTALL/lib/pkgconfig``. The file :file:`libcrypto.pc` should be located in ``$INSTALL/lib/pkgconfig``.
---------------------- ======================
Installation of OpenSC Installation of OpenSC
---------------------- ======================
The nPA Smart Card Library need the OpenSC components to be installed (especially The nPA Smart Card Library need the OpenSC components to be installed (especially
:file:`libopensc.so`). Here is an example of how to get a suitable installation :file:`libopensc.so`). Here is an example of how to get a suitable installation
of OpenSC_:: of OpenSC::
VSMARTCARD=vsmartcard VSMARTCARD=vsmartcard
git clone git://vsmartcard.git.sourceforge.net/gitroot/vsmartcard $VSMARTCARD git clone git://vsmartcard.git.sourceforge.net/gitroot/vsmartcard $VSMARTCARD
@@ -88,9 +84,9 @@ of OpenSC_::
Now :file:`libopensc.so` should be located in ``$PREFIX/lib``. Now :file:`libopensc.so` should be located in ``$PREFIX/lib``.
-------------------------------------------------------------------------------- ==========================================
Installation of the nPA Smart Card Library Installation of the nPA Smart Card Library
-------------------------------------------------------------------------------- ==========================================
To complete this step-by-step guide, here is how to install nPA Smart Card Library:: To complete this step-by-step guide, here is how to install nPA Smart Card Library::
@@ -127,8 +123,8 @@ be found in :file:`apdus`.
Linking against libnpa Linking against libnpa
---------------------- ----------------------
Following the section `Installation`_ above, you have installed OpenSSL_, Following the section Installation_ above, you have installed OpenSSL,
OpenPACE_, OpenSC_ and the nPA Smart Card Library to `$PREFIX` which points to OpenPACE, OpenSC and the nPA Smart Card Library to `$PREFIX` which points to
:file:`/tmp/install`. To compile a program using nPA Smart Card Library you also need :file:`/tmp/install`. To compile a program using nPA Smart Card Library you also need
the OpenSC header files, which are located in the OpenSC header files, which are located in
:file:`$VSMARTCARD/npa/src/opensc` Here is how to compile an external program :file:`$VSMARTCARD/npa/src/opensc` Here is how to compile an external program
@@ -145,4 +141,15 @@ Alternatively you can specify libraries and flags by hand::
-L$PREFIX/lib -lnpa -lopensc -lcrypto" -L$PREFIX/lib -lnpa -lopensc -lcrypto"
.. include:: questions.rst .. include:: questions.txt
********************
Notes and References
********************
.. target-notes::
.. _OpenSC: https://github.com/OpenSC/OpenSC
.. _OpenSSL: http://www.openssl.org
.. _OpenPACE: http://openpace.sourceforge.net

63
npa/doc/README.rst.in → npa/doc/README.txt.in
View File

@@ -1,18 +1,14 @@
.. highlight:: sh .. highlight:: sh
.. _OpenSC: https://github.com/OpenSC/OpenSC
.. _OpenSSL: http://www.openssl.org
.. _OpenPACE: http://openpace.sourceforge.net
.. |PACE| replace:: :abbr:`PACE (Password Authenticated Connection Establishment)` .. |PACE| replace:: :abbr:`PACE (Password Authenticated Connection Establishment)`
.. |npa-tool| replace:: :command:`npa-tool` .. |npa-tool| replace:: :command:`npa-tool`
.. _npa: .. _npa:
******************************************************************************** ######################
@PACKAGE_NAME@ nPA Smart Card Library
******************************************************************************** ######################
:Author: :Author:
Frank Morgner <morgner@informatik.hu-berlin.de> Frank Morgner <morgner@informatik.hu-berlin.de>
@@ -24,36 +20,36 @@
:Potential Platforms: :Potential Platforms:
Unix-like operating systems (Mac OS, Solaris, BSD, ...) Unix-like operating systems (Mac OS, Solaris, BSD, ...)
The @PACKAGE_NAME@ offers an easy to use API for the new German identity card The nPA Smart Card Library offers an easy to use API for the new German identity card
(neuer Personalausweis, nPA). The library also implements secure messaging, (neuer Personalausweis, nPA). The library also implements secure messaging,
which could also be used for other cards. The included |npa-tool| can which could also be used for other cards. The included |npa-tool| can
be used for PIN management or to send APDUs inside a secure channel. be used for PIN management or to send APDUs inside a secure channel.
The @PACKAGE_NAME@ is implemented using OpenPACE_ and OpenSC_. @PACKAGE_NAME@ The nPA Smart Card Library is implemented using OpenPACE_ and OpenSC_. nPA Smart Card Library
implements and initializes Secure Messaging wrappers of OpenSC to allow a implements and initializes Secure Messaging wrappers of OpenSC to allow a
transparent SM usage in OpenSC. This allows @PACKAGE_NAME@ to be fully transparent SM usage in OpenSC. This allows nPA Smart Card Library to be fully
compatible with OpenSC. compatible with OpenSC.
.. include:: download.rst .. include:: download.txt
.. _npa-install: .. _npa-install:
.. include:: autotools.rst .. include:: autotools.txt
The @PACKAGE_NAME@ has the following dependencies: The nPA Smart Card Library has the following dependencies:
- OpenSSL_ - OpenSSL_
- OpenPACE_ - OpenPACE_
- OpenSC_ - OpenSC_
------------------------------------ ====================================
Installation of OpenPACE and OpenSSL Installation of OpenPACE and OpenSSL
------------------------------------ ====================================
The @PACKAGE_NAME@ links against OpenSSL_, which must be patched for OpenPACE_. The nPA Smart Card Library links against OpenSSL_, which must be patched for OpenPACE_.
Here is an example of how to get the standard installation of OpenPACE_ (with Here is an example of how to get the standard installation of OpenPACE_ (with
the required binaries for OpenSSL):: the required binaries for OpenSSL)::
@@ -69,13 +65,13 @@ the required binaries for OpenSSL)::
The file :file:`libcrypto.pc` should be located in ``$INSTALL/lib/pkgconfig``. The file :file:`libcrypto.pc` should be located in ``$INSTALL/lib/pkgconfig``.
---------------------- ======================
Installation of OpenSC Installation of OpenSC
---------------------- ======================
The @PACKAGE_NAME@ need the OpenSC components to be installed (especially The nPA Smart Card Library need the OpenSC components to be installed (especially
:file:`libopensc.so`). Here is an example of how to get a suitable installation :file:`libopensc.so`). Here is an example of how to get a suitable installation
of OpenSC_:: of OpenSC::
VSMARTCARD=vsmartcard VSMARTCARD=vsmartcard
git clone git://vsmartcard.git.sourceforge.net/gitroot/vsmartcard $VSMARTCARD git clone git://vsmartcard.git.sourceforge.net/gitroot/vsmartcard $VSMARTCARD
@@ -88,11 +84,11 @@ of OpenSC_::
Now :file:`libopensc.so` should be located in ``$PREFIX/lib``. Now :file:`libopensc.so` should be located in ``$PREFIX/lib``.
-------------------------------------------------------------------------------- ==========================================
Installation of the @PACKAGE_NAME@ Installation of the nPA Smart Card Library
-------------------------------------------------------------------------------- ==========================================
To complete this step-by-step guide, here is how to install @PACKAGE_NAME@:: To complete this step-by-step guide, here is how to install nPA Smart Card Library::
cd $VSMARTCARD/npa cd $VSMARTCARD/npa
autoreconf --verbose --install autoreconf --verbose --install
@@ -127,9 +123,9 @@ be found in :file:`apdus`.
Linking against libnpa Linking against libnpa
---------------------- ----------------------
Following the section `Installation`_ above, you have installed OpenSSL_, Following the section Installation_ above, you have installed OpenSSL,
OpenPACE_, OpenSC_ and the @PACKAGE_NAME@ to `$PREFIX` which points to OpenPACE, OpenSC and the nPA Smart Card Library to `$PREFIX` which points to
:file:`/tmp/install`. To compile a program using @PACKAGE_NAME@ you also need :file:`/tmp/install`. To compile a program using nPA Smart Card Library you also need
the OpenSC header files, which are located in the OpenSC header files, which are located in
:file:`$VSMARTCARD/npa/src/opensc` Here is how to compile an external program :file:`$VSMARTCARD/npa/src/opensc` Here is how to compile an external program
with these libraries:: with these libraries::
@@ -145,4 +141,15 @@ Alternatively you can specify libraries and flags by hand::
-L$PREFIX/lib -lnpa -lopensc -lcrypto" -L$PREFIX/lib -lnpa -lopensc -lcrypto"
.. include:: questions.rst .. include:: questions.txt
********************
Notes and References
********************
.. target-notes::
.. _OpenSC: https://github.com/OpenSC/OpenSC
.. _OpenSSL: http://www.openssl.org
.. _OpenPACE: http://openpace.sourceforge.net

0
npa/doc/api.rst → npa/doc/api.txt
View File

1
npa/doc/autotools.rst.in
View File

@@ -1 +0,0 @@
../../doc/autotools.rst.in

4
npa/doc/autotools.rst → npa/doc/autotools.txt
View File

@@ -1,8 +1,8 @@
.. highlight:: sh .. highlight:: sh
============ ************
Installation Installation
============ ************
The nPA Smart Card Library uses the GNU Build System to compile and install. If you are The nPA Smart Card Library 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 unfamiliar with it, please have a look at :file:`INSTALL`. If you have a look

1
npa/doc/autotools.txt.in Symbolic link
View File

@@ -0,0 +1 @@
../../doc/autotools.txt.in

1
npa/doc/download.rst.in
View File

@@ -1 +0,0 @@
../../doc/download.rst.in

4
npa/doc/download.rst → npa/doc/download.txt
View File

@@ -1,8 +1,8 @@
.. highlight:: sh .. highlight:: sh
=============================================================================== ********
Download Download
=============================================================================== ********
You can find the latest release of nPA Smart Card Library `here You can find the latest release of nPA Smart Card Library `here
<http://sourceforge.net/projects/vsmartcard/files>`_. <http://sourceforge.net/projects/vsmartcard/files>`_.

1
npa/doc/download.txt.in Symbolic link
View File

@@ -0,0 +1 @@
../../doc/download.txt.in

1
npa/doc/questions.rst.in
View File

@@ -1 +0,0 @@
../../doc/questions.rst.in

4
virtualsmartcard/doc/questions.rst → npa/doc/questions.txt
View File

@@ -1,6 +1,6 @@
======== ********
Question Question
======== ********
Do you have questions, suggestions or contributions? Feedback of any kind is Do you have questions, suggestions or contributions? Feedback of any kind is
more than welcome! Please use our `project trackers <http://sourceforge.net/projects/vsmartcard/support>`_. more than welcome! Please use our `project trackers <http://sourceforge.net/projects/vsmartcard/support>`_.

1
npa/doc/questions.txt.in Symbolic link
View File

@@ -0,0 +1 @@
../../doc/questions.txt.in

2
pcsc-relay/README
View File

@@ -1 +1 @@
doc/README.rst doc/README.txt

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

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

45
pcsc-relay/doc/README.rst → pcsc-relay/doc/README.txt
View File

@@ -1,14 +1,10 @@
.. highlight:: sh .. highlight:: sh
.. _libnfc: http://www.libnfc.org/
.. _OpenPICC: http://www.openpcd.org/OpenPICC
.. _PCSC-lite: http://pcsclite.alioth.debian.org/
.. _pcsc-relay: .. _pcsc-relay:
******************************************************************************** ###########
PC/SC Relay PC/SC Relay
******************************************************************************** ###########
:Authors: :Authors:
- Frank Morgner <morgner@informatik.hu-berlin.de> - Frank Morgner <morgner@informatik.hu-berlin.de>
@@ -35,25 +31,24 @@ emulate an ISO/IEC 14443 smart card.
.. note:: .. note::
This software can actually be used in a relay attack allowing full access This software can actually be used in a relay attack allowing full access
to the card. `We discussed the impact especially on the German identity to the card. We discussed the impact especially on the `Relay attack
card against the German ID card`_, but it generally concerns *all* contact-less
<http://media.ccc.de/browse/congress/2010/27c3-4297-de-die_gesamte_technik_ist_sicher.html>`_, smart cards.
but it generally concerns *all* contact-less smart cards.
.. include:: download.rst .. include:: download.txt
.. include:: autotools.rst .. include:: autotools.txt
PC/SC Relay has the following dependencies: PC/SC Relay has the following dependencies:
- PC/SC middleware - PC/SC middleware
- libnfc_ - libnfc_
--------------- ===============
Hints on libnfc Hints on libnfc
--------------- ===============
PC/SC Relay links against libnfc_. Here is an example of how to get the standard PC/SC Relay links against libnfc_. Here is an example of how to get the standard
installation of the latter:: installation of the latter::
@@ -74,9 +69,9 @@ configure PC/SC Relay to use it::
./configure PKG_CONFIG_PATH=$PREFIX/lib/pkgconfig ./configure PKG_CONFIG_PATH=$PREFIX/lib/pkgconfig
------------------------- =========================
Hints on PC/SC middleware Hints on PC/SC middleware
------------------------- =========================
A PC/SC middleware is included by default in most modern operating systems. On 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 Unix-like systems (Linux, OS X, Sun OS) it is realized by PCSC-Lite_. To
@@ -88,11 +83,23 @@ Microsoft's developement environment Visual Studio includes all necessary data
for building PC/SC Relay. for building PC/SC Relay.
===== *****
Usage Usage
===== *****
.. program-output:: pcsc-relay --help .. program-output:: pcsc-relay --help
.. include:: questions.rst .. include:: questions.txt
********************
Notes and References
********************
.. target-notes::
.. _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

65
pcsc-relay/doc/README.rst.in → pcsc-relay/doc/README.txt.in
View File

@@ -1,14 +1,10 @@
.. highlight:: sh .. highlight:: sh
.. _libnfc: http://www.libnfc.org/
.. _OpenPICC: http://www.openpcd.org/OpenPICC
.. _PCSC-lite: http://pcsclite.alioth.debian.org/
.. _pcsc-relay: .. _pcsc-relay:
******************************************************************************** ###########
@PACKAGE_NAME@ PC/SC Relay
******************************************************************************** ###########
:Authors: :Authors:
- Frank Morgner <morgner@informatik.hu-berlin.de> - Frank Morgner <morgner@informatik.hu-berlin.de>
@@ -21,7 +17,7 @@
:Potential Platforms: :Potential Platforms:
Unix-like operating systems (Mac OS, Solaris, BSD, ...) Unix-like operating systems (Mac OS, Solaris, BSD, ...)
Welcome to @PACKAGE_NAME@. The purpose of @PACKAGE_NAME@ is to relay a smart 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 card using an contact-less interface. Currently the following contact-less
backends: backends:
@@ -30,32 +26,31 @@ backends:
Command APDUs are received with the contact-less interface and forwarded to an 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. existing smart card via PC/SC. The Response APDUs are then sent back via RFID.
You can use @PACKAGE_NAME@ in combination with the :ref:`vicc` to completely You can use PC/SC Relay in combination with the :ref:`vicc` to completely
emulate an ISO/IEC 14443 smart card. emulate an ISO/IEC 14443 smart card.
.. note:: .. note::
This software can actually be used in a relay attack allowing full access This software can actually be used in a relay attack allowing full access
to the card. `We discussed the impact especially on the German identity to the card. We discussed the impact especially on the `Relay attack
card against the German ID card`_, but it generally concerns *all* contact-less
<http://media.ccc.de/browse/congress/2010/27c3-4297-de-die_gesamte_technik_ist_sicher.html>`_, smart cards.
but it generally concerns *all* contact-less smart cards.
.. include:: download.rst .. include:: download.txt
.. include:: autotools.rst .. include:: autotools.txt
@PACKAGE_NAME@ has the following dependencies: PC/SC Relay has the following dependencies:
- PC/SC middleware - PC/SC middleware
- libnfc_ - libnfc_
--------------- ===============
Hints on libnfc Hints on libnfc
--------------- ===============
@PACKAGE_NAME@ links against libnfc_. Here is an example of how to get the standard PC/SC Relay links against libnfc_. Here is an example of how to get the standard
installation of the latter:: installation of the latter::
PREFIX=/tmp/install PREFIX=/tmp/install
@@ -67,32 +62,44 @@ installation of the latter::
make make
make install make install
Building @PACKAGE_NAME@ 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 :file:`libnfc.pc` should be located in ``$INSTALL/lib/pkgconfig``. Here is how to
configure @PACKAGE_NAME@ to use it:: configure PC/SC Relay to use it::
./configure PKG_CONFIG_PATH=$PREFIX/lib/pkgconfig ./configure PKG_CONFIG_PATH=$PREFIX/lib/pkgconfig
------------------------- =========================
Hints on PC/SC middleware Hints on PC/SC middleware
------------------------- =========================
A PC/SC middleware is included by default in most modern operating systems. On 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 Unix-like systems (Linux, OS X, Sun OS) it is realized by PCSC-Lite_. To
compile @PACKAGE_NAME@ 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. your distribution.
Windows also ships with a PC/SC middleware in form of the Winscard module. Windows also ships with a PC/SC middleware in form of the Winscard module.
Microsoft's developement environment Visual Studio includes all necessary data Microsoft's developement environment Visual Studio includes all necessary data
for building @PACKAGE_NAME@. for building PC/SC Relay.
===== *****
Usage Usage
===== *****
.. program-output:: @PACKAGE@ --help .. program-output:: pcsc-relay --help
.. include:: questions.rst .. include:: questions.txt
********************
Notes and References
********************
.. target-notes::
.. _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

1
pcsc-relay/doc/autotools.rst.in
View File

@@ -1 +0,0 @@
../../doc/autotools.rst.in

4
pcsc-relay/doc/autotools.rst → pcsc-relay/doc/autotools.txt
View File

@@ -1,8 +1,8 @@
.. highlight:: sh .. highlight:: sh
============ ************
Installation Installation
============ ************
The PC/SC Relay uses the GNU Build System to compile and install. If you are 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 unfamiliar with it, please have a look at :file:`INSTALL`. If you have a look

1
pcsc-relay/doc/autotools.txt.in Symbolic link
View File

@@ -0,0 +1 @@
../../doc/autotools.txt.in

1
pcsc-relay/doc/download.rst.in
View File

@@ -1 +0,0 @@
../../doc/download.rst.in

4
pcsc-relay/doc/download.rst → pcsc-relay/doc/download.txt
View File

@@ -1,8 +1,8 @@
.. highlight:: sh .. highlight:: sh
=============================================================================== ********
Download Download
=============================================================================== ********
You can find the latest release of PC/SC Relay `here You can find the latest release of PC/SC Relay `here
<http://sourceforge.net/projects/vsmartcard/files>`_. <http://sourceforge.net/projects/vsmartcard/files>`_.

1
pcsc-relay/doc/download.txt.in Symbolic link
View File

@@ -0,0 +1 @@
../../doc/download.txt.in

1
pcsc-relay/doc/questions.rst.in
View File

@@ -1 +0,0 @@
../../doc/questions.rst.in

4
npa/doc/questions.rst → pcsc-relay/doc/questions.txt
View File

@@ -1,6 +1,6 @@
======== ********
Question Question
======== ********
Do you have questions, suggestions or contributions? Feedback of any kind is Do you have questions, suggestions or contributions? Feedback of any kind is
more than welcome! Please use our `project trackers <http://sourceforge.net/projects/vsmartcard/support>`_. more than welcome! Please use our `project trackers <http://sourceforge.net/projects/vsmartcard/support>`_.

1
pcsc-relay/doc/questions.txt.in Symbolic link
View File

@@ -0,0 +1 @@
../../doc/questions.txt.in

2
virtualsmartcard/README
View File

@@ -1 +1 @@
doc/README.rst doc/README.txt

12
virtualsmartcard/doc/Makefile.am
View File

@@ -17,16 +17,16 @@ do_subst = $(SED) \
-e 's,[@]abs_top_srcdir[@],$(abs_top_srcdir),g' \ -e 's,[@]abs_top_srcdir[@],$(abs_top_srcdir),g' \
-e 's,[@]top_srcdir[@],$(top_srcdir),g' -e 's,[@]top_srcdir[@],$(top_srcdir),g'
EXTRA_DIST = README.rst.in README.rst autotools.rst.in questions.rst.in autotools.rst questions.rst download.rst.in download.rst EXTRA_DIST = README.txt.in README.txt autotools.txt.in questions.txt.in autotools.txt questions.txt download.txt.in download.txt
dist_noinst_SCRIPTS = generate_modules.py dist_noinst_SCRIPTS = generate_modules.py
doc: $(top_srcdir)/src/vpicc/virtualsmartcard/*.py $(top_srcdir)/src/vpicc/virtualsmartcard/cards/*.py generate_modules.py *.in doc: $(top_srcdir)/src/vpicc/virtualsmartcard/*.py $(top_srcdir)/src/vpicc/virtualsmartcard/cards/*.py generate_modules.py *.in
$(do_subst) < autotools.rst.in > autotools.rst $(do_subst) < autotools.txt.in > autotools.txt
$(do_subst) < questions.rst.in > questions.rst $(do_subst) < questions.txt.in > questions.txt
$(do_subst) < download.rst.in > download.rst $(do_subst) < download.txt.in > download.txt
$(do_subst) < README.rst.in > README.rst $(do_subst) < README.txt.in > README.txt
./generate_modules.py $(top_srcdir)/src/vpicc --dest-dir=api --suffix=rst --no-toc -1 -f ./generate_modules.py $(top_srcdir)/src/vpicc --dest-dir=api --suffix=txt --no-toc -1 -f
touch doc touch doc
clean-local: clean-local:

45
virtualsmartcard/doc/README.rst → virtualsmartcard/doc/README.txt
View File

@@ -1,14 +1,5 @@
.. highlight:: sh .. highlight:: sh
.. _PBKDF2: https://www.dlitz.net/software/python-pbkdf2/
.. _PCSC-lite: http://pcsclite.alioth.debian.org/
.. _PCSC-lite: http://pcsclite.alioth.debian.org/
.. _PIP: http://www.pythonware.com/products/pil/
.. _PyCrypto: http://pycrypto.org/
.. _Python: http://www.python.org/
.. _cyberflex-shell: https://github.com/henryk/cyberflex-shell
.. _pyscard: http://pyscard.sourceforge.net/
.. |vpicc| replace:: :abbr:`vpicc (virtual smart card)` .. |vpicc| replace:: :abbr:`vpicc (virtual smart card)`
.. |vpcd| replace:: :abbr:`vpcd (virtual smart card reader)` .. |vpcd| replace:: :abbr:`vpcd (virtual smart card reader)`
.. |EAC| replace:: :abbr:`EAC (Extended Access Control)` .. |EAC| replace:: :abbr:`EAC (Extended Access Control)`
@@ -19,9 +10,9 @@
.. _vicc: .. _vicc:
******************************************************************************** ##################
Virtual Smart Card Virtual Smart Card
******************************************************************************** ##################
:Authors: :Authors:
- Frank Morgner <morgner@informatik.hu-berlin.de> - Frank Morgner <morgner@informatik.hu-berlin.de>
@@ -55,10 +46,10 @@ reader.
The file :file:`utils.py` was taken from Henryk Plötz's cyberflex-shell_. The file :file:`utils.py` was taken from Henryk Plötz's cyberflex-shell_.
.. include:: download.rst .. include:: download.txt
.. include:: autotools.rst .. include:: autotools.txt
Depending on your usage of the |vpicc| you might or might not need Depending on your usage of the |vpicc| you might or might not need
the following: the following:
@@ -72,11 +63,11 @@ the following:
The |vpcd| depends on PCSC-Lite_. The |vpcd| depends on PCSC-Lite_.
================================================================================ ******************************
Running the Virtual Smart Card Running the Virtual Smart Card
================================================================================ ******************************
First you need to make sure that :command:`pcscd` loads the |vpcd|. You might Fitxt you need to make sure that :command:`pcscd` loads the |vpcd|. You might
need to run :command:`update-reader.conf` to update its configuration file. need to run :command:`update-reader.conf` to update its configuration file.
Then :command:`pcscd -f -d` should say something like "Attempting startup of Then :command:`pcscd -f -d` should say something like "Attempting startup of
Virtual PCD" Virtual PCD"
@@ -90,9 +81,10 @@ You should now be able to access the |vpicc| through the PC/SC API via
|vpcd|/:command:`pcscd`. You can use the :command:`opensc-explorer` or |vpcd|/:command:`pcscd`. You can use the :command:`opensc-explorer` or
:command:`pcsc_scan` for testing. :command:`pcsc_scan` for testing.
--------------------------------------------------------------------------------
==========================================================
Accessing the Virtual Smart Card from Windows applications Accessing the Virtual Smart Card from Windows applications
-------------------------------------------------------------------------------- ==========================================================
Running |vpcd| under Windows is currently not supported, because it implements Running |vpcd| under Windows is currently not supported, because it implements
a smart card driver specific for PCSC-Lite (:command:`pcscd`). This means, that a smart card driver specific for PCSC-Lite (:command:`pcscd`). This means, that
@@ -120,4 +112,19 @@ However, there are several more or less complicated paths you can go:
PC/SC provider for a native Windows application. PC/SC provider for a native Windows application.
.. include:: questions.rst .. include:: questions.txt
********************
Notes and References
********************
.. target-notes::
.. _PBKDF2: https://www.dlitz.net/software/python-pbkdf2/
.. _PCSC-lite: http://pcsclite.alioth.debian.org/
.. _PIP: http://www.pythonware.com/products/pil/
.. _PyCrypto: http://pycrypto.org/
.. _Python: http://www.python.org/
.. _cyberflex-shell: https://github.com/henryk/cyberflex-shell
.. _pyscard: http://pyscard.sourceforge.net/

57
virtualsmartcard/doc/README.rst.in → virtualsmartcard/doc/README.txt.in
View File

@@ -1,14 +1,5 @@
.. highlight:: sh .. highlight:: sh
.. _PBKDF2: https://www.dlitz.net/software/python-pbkdf2/
.. _PCSC-lite: http://pcsclite.alioth.debian.org/
.. _PCSC-lite: http://pcsclite.alioth.debian.org/
.. _PIP: http://www.pythonware.com/products/pil/
.. _PyCrypto: http://pycrypto.org/
.. _Python: http://www.python.org/
.. _cyberflex-shell: https://github.com/henryk/cyberflex-shell
.. _pyscard: http://pyscard.sourceforge.net/
.. |vpicc| replace:: :abbr:`vpicc (virtual smart card)` .. |vpicc| replace:: :abbr:`vpicc (virtual smart card)`
.. |vpcd| replace:: :abbr:`vpcd (virtual smart card reader)` .. |vpcd| replace:: :abbr:`vpcd (virtual smart card reader)`
.. |EAC| replace:: :abbr:`EAC (Extended Access Control)` .. |EAC| replace:: :abbr:`EAC (Extended Access Control)`
@@ -19,9 +10,9 @@
.. _vicc: .. _vicc:
******************************************************************************** ##################
@PACKAGE_NAME@ Virtual Smart Card
******************************************************************************** ##################
:Authors: :Authors:
- Frank Morgner <morgner@informatik.hu-berlin.de> - Frank Morgner <morgner@informatik.hu-berlin.de>
@@ -34,8 +25,8 @@
:Potential Platforms: :Potential Platforms:
Unix-like operating systems (Mac OS, Solaris, BSD, ...) Unix-like operating systems (Mac OS, Solaris, BSD, ...)
@PACKAGE_NAME@ emulates a smart card and makes it accessible through PC/SC. Virtual Smart Card emulates a smart card and makes it accessible through PC/SC.
Currently the @PACKAGE_NAME@ supports the following types of smart cards: Currently the Virtual Smart Card supports the following types of smart cards:
- Generic ISO-7816 smart card including secure messaging - Generic ISO-7816 smart card including secure messaging
- German electronic identity card (nPA) with complete support for |EAC| (|PACE|, |TA|, |CA|) - German electronic identity card (nPA) with complete support for |EAC| (|PACE|, |TA|, |CA|)
@@ -48,17 +39,17 @@ default |vpicc| communicates with |vpcd| through a socket on localhost port
35963. But the |vpicc| does not need to run on the same machine as the |vpcd|, 35963. But the |vpicc| does not need to run on the same machine as the |vpcd|,
they can connect over the internet for example. they can connect over the internet for example.
Although the @PACKAGE_NAME@ is a software emulator, you can use Although the Virtual Smart Card is a software emulator, you can use
:ref:`pcsc-relay` to make it accessible to an external contact-less smart card :ref:`pcsc-relay` to make it accessible to an external contact-less smart card
reader. reader.
The file :file:`utils.py` was taken from Henryk Plötz's cyberflex-shell_. The file :file:`utils.py` was taken from Henryk Plötz's cyberflex-shell_.
.. include:: download.rst .. include:: download.txt
.. include:: autotools.rst .. include:: autotools.txt
Depending on your usage of the |vpicc| you might or might not need Depending on your usage of the |vpicc| you might or might not need
the following: the following:
@@ -72,11 +63,11 @@ the following:
The |vpcd| depends on PCSC-Lite_. The |vpcd| depends on PCSC-Lite_.
================================================================================ ******************************
Running the @PACKAGE_NAME@ Running the Virtual Smart Card
================================================================================ ******************************
First you need to make sure that :command:`pcscd` loads the |vpcd|. You might Fitxt you need to make sure that :command:`pcscd` loads the |vpcd|. You might
need to run :command:`update-reader.conf` to update its configuration file. need to run :command:`update-reader.conf` to update its configuration file.
Then :command:`pcscd -f -d` should say something like "Attempting startup of Then :command:`pcscd -f -d` should say something like "Attempting startup of
Virtual PCD" Virtual PCD"
@@ -90,9 +81,10 @@ You should now be able to access the |vpicc| through the PC/SC API via
|vpcd|/:command:`pcscd`. You can use the :command:`opensc-explorer` or |vpcd|/:command:`pcscd`. You can use the :command:`opensc-explorer` or
:command:`pcsc_scan` for testing. :command:`pcsc_scan` for testing.
--------------------------------------------------------------------------------
Accessing the @PACKAGE_NAME@ from Windows applications ==========================================================
-------------------------------------------------------------------------------- Accessing the Virtual Smart Card from Windows applications
==========================================================
Running |vpcd| under Windows is currently not supported, because it implements Running |vpcd| under Windows is currently not supported, because it implements
a smart card driver specific for PCSC-Lite (:command:`pcscd`). This means, that a smart card driver specific for PCSC-Lite (:command:`pcscd`). This means, that
@@ -120,4 +112,19 @@ However, there are several more or less complicated paths you can go:
PC/SC provider for a native Windows application. PC/SC provider for a native Windows application.
.. include:: questions.rst .. include:: questions.txt
********************
Notes and References
********************
.. target-notes::
.. _PBKDF2: https://www.dlitz.net/software/python-pbkdf2/
.. _PCSC-lite: http://pcsclite.alioth.debian.org/
.. _PIP: http://www.pythonware.com/products/pil/
.. _PyCrypto: http://pycrypto.org/
.. _Python: http://www.python.org/
.. _cyberflex-shell: https://github.com/henryk/cyberflex-shell
.. _pyscard: http://pyscard.sourceforge.net/

0
virtualsmartcard/doc/api.rst → virtualsmartcard/doc/api.txt
View File

10
virtualsmartcard/doc/api/virtualsmartcard.CardGenerator.txt Normal file
View File

@@ -0,0 +1,10 @@
CardGenerator Module
====================
.. inheritance-diagram:: virtualsmartcard.CardGenerator
.. automodule:: virtualsmartcard.CardGenerator
:members:
:undoc-members:
:inherited-members:
:show-inheritance:
:private-members:

10
virtualsmartcard/doc/api/virtualsmartcard.ConstantDefinitions.txt Normal file
View File

@@ -0,0 +1,10 @@
ConstantDefinitions Module
==========================
.. inheritance-diagram:: virtualsmartcard.ConstantDefinitions
.. automodule:: virtualsmartcard.ConstantDefinitions
:members:
:undoc-members:
:inherited-members:
:show-inheritance:
:private-members:

10
virtualsmartcard/doc/api/virtualsmartcard.CryptoUtils.txt Normal file
View File

@@ -0,0 +1,10 @@
CryptoUtils Module
==================
.. inheritance-diagram:: virtualsmartcard.CryptoUtils
.. automodule:: virtualsmartcard.CryptoUtils
:members:
:undoc-members:
:inherited-members:
:show-inheritance:
:private-members:

10
virtualsmartcard/doc/api/virtualsmartcard.SEutils.txt Normal file
View File

@@ -0,0 +1,10 @@
SEutils Module
==============
.. inheritance-diagram:: virtualsmartcard.SEutils
.. automodule:: virtualsmartcard.SEutils
:members:
:undoc-members:
:inherited-members:
:show-inheritance:
:private-members:

10
virtualsmartcard/doc/api/virtualsmartcard.SWutils.txt Normal file
View File

@@ -0,0 +1,10 @@
SWutils Module
==============
.. inheritance-diagram:: virtualsmartcard.SWutils
.. automodule:: virtualsmartcard.SWutils
:members:
:undoc-members:
:inherited-members:
:show-inheritance:
:private-members:

10
virtualsmartcard/doc/api/virtualsmartcard.SmartcardFilesystem.txt Normal file
View File

@@ -0,0 +1,10 @@
SmartcardFilesystem Module
==========================
.. inheritance-diagram:: virtualsmartcard.SmartcardFilesystem
.. automodule:: virtualsmartcard.SmartcardFilesystem
:members:
:undoc-members:
:inherited-members:
:show-inheritance:
:private-members:

10
virtualsmartcard/doc/api/virtualsmartcard.SmartcardSAM.txt Normal file
View File

@@ -0,0 +1,10 @@
SmartcardSAM Module
===================
.. inheritance-diagram:: virtualsmartcard.SmartcardSAM
.. automodule:: virtualsmartcard.SmartcardSAM
:members:
:undoc-members:
:inherited-members:
:show-inheritance:
:private-members:

10
virtualsmartcard/doc/api/virtualsmartcard.TLVutils.txt Normal file
View File

@@ -0,0 +1,10 @@
TLVutils Module
===============
.. inheritance-diagram:: virtualsmartcard.TLVutils
.. automodule:: virtualsmartcard.TLVutils
:members:
:undoc-members:
:inherited-members:
:show-inheritance:
:private-members:

10
virtualsmartcard/doc/api/virtualsmartcard.VirtualSmartcard.txt Normal file
View File

@@ -0,0 +1,10 @@
VirtualSmartcard Module
=======================
.. inheritance-diagram:: virtualsmartcard.VirtualSmartcard
.. automodule:: virtualsmartcard.VirtualSmartcard
:members:
:undoc-members:
:inherited-members:
:show-inheritance:
:private-members:

10
virtualsmartcard/doc/api/virtualsmartcard.cards.cryptoflex.txt Normal file
View File

@@ -0,0 +1,10 @@
cryptoflex Module
=================
.. inheritance-diagram:: virtualsmartcard.cards.cryptoflex
.. automodule:: virtualsmartcard.cards.cryptoflex
:members:
:undoc-members:
:inherited-members:
:show-inheritance:
:private-members:

10
virtualsmartcard/doc/api/virtualsmartcard.cards.ePass.txt Normal file
View File

@@ -0,0 +1,10 @@
ePass Module
============
.. inheritance-diagram:: virtualsmartcard.cards.ePass
.. automodule:: virtualsmartcard.cards.ePass
:members:
:undoc-members:
:inherited-members:
:show-inheritance:
:private-members:

10
virtualsmartcard/doc/api/virtualsmartcard.cards.nPA.txt Normal file
View File

@@ -0,0 +1,10 @@
nPA Module
==========
.. inheritance-diagram:: virtualsmartcard.cards.nPA
.. automodule:: virtualsmartcard.cards.nPA
:members:
:undoc-members:
:inherited-members:
:show-inheritance:
:private-members:

9
virtualsmartcard/doc/api/virtualsmartcard.cards.txt Normal file
View File

@@ -0,0 +1,9 @@
cards Package
=============
.. toctree::
virtualsmartcard.cards.cryptoflex
virtualsmartcard.cards.ePass
virtualsmartcard.cards.nPA

17
virtualsmartcard/doc/api/virtualsmartcard.txt Normal file
View File

@@ -0,0 +1,17 @@
virtualsmartcard Package
========================
.. toctree::
virtualsmartcard.cards
virtualsmartcard.CardGenerator
virtualsmartcard.ConstantDefinitions
virtualsmartcard.CryptoUtils
virtualsmartcard.SEutils
virtualsmartcard.SWutils
virtualsmartcard.SmartcardFilesystem
virtualsmartcard.SmartcardSAM
virtualsmartcard.TLVutils
virtualsmartcard.VirtualSmartcard
virtualsmartcard.utils

10
virtualsmartcard/doc/api/virtualsmartcard.utils.txt Normal file
View File

@@ -0,0 +1,10 @@
utils Module
============
.. inheritance-diagram:: virtualsmartcard.utils
.. automodule:: virtualsmartcard.utils
:members:
:undoc-members:
:inherited-members:
:show-inheritance:
:private-members:

1
virtualsmartcard/doc/autotools.rst.in
View File

@@ -1 +0,0 @@
../../doc/autotools.rst.in

4
virtualsmartcard/doc/autotools.rst → virtualsmartcard/doc/autotools.txt
View File

@@ -1,8 +1,8 @@
.. highlight:: sh .. highlight:: sh
============ ************
Installation Installation
============ ************
The Virtual Smart Card uses the GNU Build System to compile and install. If you are The Virtual Smart Card 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 unfamiliar with it, please have a look at :file:`INSTALL`. If you have a look

1
virtualsmartcard/doc/autotools.txt.in Symbolic link
View File

@@ -0,0 +1 @@
../../doc/autotools.txt.in

1
virtualsmartcard/doc/download.rst.in
View File

@@ -1 +0,0 @@
../../doc/download.rst.in

4
virtualsmartcard/doc/download.rst → virtualsmartcard/doc/download.txt
View File

@@ -1,8 +1,8 @@
.. highlight:: sh .. highlight:: sh
=============================================================================== ********
Download Download
=============================================================================== ********
You can find the latest release of Virtual Smart Card `here You can find the latest release of Virtual Smart Card `here
<http://sourceforge.net/projects/vsmartcard/files>`_. <http://sourceforge.net/projects/vsmartcard/files>`_.

1
virtualsmartcard/doc/download.txt.in Symbolic link
View File

@@ -0,0 +1 @@
../../doc/download.txt.in

1
virtualsmartcard/doc/questions.rst.in
View File

@@ -1 +0,0 @@
../../doc/questions.rst.in

4
pcsc-relay/doc/questions.rst → virtualsmartcard/doc/questions.txt
View File

@@ -1,6 +1,6 @@
======== ********
Question Question
======== ********
Do you have questions, suggestions or contributions? Feedback of any kind is Do you have questions, suggestions or contributions? Feedback of any kind is
more than welcome! Please use our `project trackers <http://sourceforge.net/projects/vsmartcard/support>`_. more than welcome! Please use our `project trackers <http://sourceforge.net/projects/vsmartcard/support>`_.

1
virtualsmartcard/doc/questions.txt.in Symbolic link
View File

@@ -0,0 +1 @@
../../doc/questions.txt.in