From 37e5f9d5140d8f43b8740263917a19610c132b38 Mon Sep 17 00:00:00 2001 From: Frank Morgner Date: Tue, 5 Mar 2013 20:42:09 +0100 Subject: [PATCH] respect sphinx style guide to some extent see http://documentation-style-guide-sphinx.readthedocs.org/en/latest/style-guide.html --- ccid/README | 2 +- ccid/doc/Makefile.am | 10 +-- ccid/doc/{README.rst => README.txt} | 51 ++++++------ ccid/doc/{README.rst.in => README.txt.in} | 79 ++++++++++--------- ccid/doc/autotools.rst.in | 1 - ccid/doc/{autotools.rst => autotools.txt} | 4 +- ccid/doc/autotools.txt.in | 1 + ccid/doc/download.rst.in | 1 - ccid/doc/download.txt | 12 +++ ccid/doc/download.txt.in | 1 + ccid/doc/questions.rst.in | 1 - ccid/doc/{questions.rst => questions.txt} | 4 +- ccid/doc/questions.txt.in | 1 + doc/{autotools.rst.in => autotools.txt.in} | 4 +- doc/conf.py | 4 +- doc/{download.rst.in => download.txt.in} | 4 +- doc/{index.rst => index.txt} | 0 doc/{questions.rst.in => questions.txt.in} | 4 +- npa/README | 2 +- npa/doc/Makefile.am | 12 +-- npa/doc/{README.rst => README.txt} | 43 +++++----- npa/doc/{README.rst.in => README.txt.in} | 63 ++++++++------- npa/doc/{api.rst => api.txt} | 0 npa/doc/autotools.rst.in | 1 - npa/doc/{autotools.rst => autotools.txt} | 4 +- npa/doc/autotools.txt.in | 1 + npa/doc/download.rst.in | 1 - npa/doc/{download.rst => download.txt} | 4 +- npa/doc/download.txt.in | 1 + npa/doc/questions.rst.in | 1 - .../questions.rst => npa/doc/questions.txt | 4 +- npa/doc/questions.txt.in | 1 + pcsc-relay/README | 2 +- pcsc-relay/doc/Makefile.am | 10 +-- pcsc-relay/doc/{README.rst => README.txt} | 45 ++++++----- .../doc/{README.rst.in => README.txt.in} | 65 ++++++++------- pcsc-relay/doc/autotools.rst.in | 1 - .../doc/{autotools.rst => autotools.txt} | 4 +- pcsc-relay/doc/autotools.txt.in | 1 + pcsc-relay/doc/download.rst.in | 1 - pcsc-relay/doc/{download.rst => download.txt} | 4 +- pcsc-relay/doc/download.txt.in | 1 + pcsc-relay/doc/questions.rst.in | 1 - .../doc/questions.txt | 4 +- pcsc-relay/doc/questions.txt.in | 1 + virtualsmartcard/README | 2 +- virtualsmartcard/doc/Makefile.am | 12 +-- .../doc/{README.rst => README.txt} | 45 ++++++----- .../doc/{README.rst.in => README.txt.in} | 57 +++++++------ virtualsmartcard/doc/{api.rst => api.txt} | 0 .../api/virtualsmartcard.CardGenerator.txt | 10 +++ .../virtualsmartcard.ConstantDefinitions.txt | 10 +++ .../doc/api/virtualsmartcard.CryptoUtils.txt | 10 +++ .../doc/api/virtualsmartcard.SEutils.txt | 10 +++ .../doc/api/virtualsmartcard.SWutils.txt | 10 +++ .../virtualsmartcard.SmartcardFilesystem.txt | 10 +++ .../doc/api/virtualsmartcard.SmartcardSAM.txt | 10 +++ .../doc/api/virtualsmartcard.TLVutils.txt | 10 +++ .../api/virtualsmartcard.VirtualSmartcard.txt | 10 +++ .../api/virtualsmartcard.cards.cryptoflex.txt | 10 +++ .../doc/api/virtualsmartcard.cards.ePass.txt | 10 +++ .../doc/api/virtualsmartcard.cards.nPA.txt | 10 +++ .../doc/api/virtualsmartcard.cards.txt | 9 +++ virtualsmartcard/doc/api/virtualsmartcard.txt | 17 ++++ .../doc/api/virtualsmartcard.utils.txt | 10 +++ virtualsmartcard/doc/autotools.rst.in | 1 - .../doc/{autotools.rst => autotools.txt} | 4 +- virtualsmartcard/doc/autotools.txt.in | 1 + virtualsmartcard/doc/download.rst.in | 1 - .../doc/{download.rst => download.txt} | 4 +- virtualsmartcard/doc/download.txt.in | 1 + virtualsmartcard/doc/questions.rst.in | 1 - .../doc/questions.txt | 4 +- virtualsmartcard/doc/questions.txt.in | 1 + 74 files changed, 488 insertions(+), 264 deletions(-) rename ccid/doc/{README.rst => README.txt} (80%) rename ccid/doc/{README.rst.in => README.txt.in} (61%) delete mode 120000 ccid/doc/autotools.rst.in rename ccid/doc/{autotools.rst => autotools.txt} (95%) create mode 120000 ccid/doc/autotools.txt.in delete mode 120000 ccid/doc/download.rst.in create mode 100644 ccid/doc/download.txt create mode 120000 ccid/doc/download.txt.in delete mode 120000 ccid/doc/questions.rst.in rename ccid/doc/{questions.rst => questions.txt} (91%) create mode 120000 ccid/doc/questions.txt.in rename doc/{autotools.rst.in => autotools.txt.in} (95%) rename doc/{download.rst.in => download.txt.in} (62%) rename doc/{index.rst => index.txt} (100%) rename doc/{questions.rst.in => questions.txt.in} (90%) rename npa/doc/{README.rst => README.txt} (86%) rename npa/doc/{README.rst.in => README.txt.in} (72%) rename npa/doc/{api.rst => api.txt} (100%) delete mode 120000 npa/doc/autotools.rst.in rename npa/doc/{autotools.rst => autotools.txt} (95%) create mode 120000 npa/doc/autotools.txt.in delete mode 120000 npa/doc/download.rst.in rename npa/doc/{download.rst => download.txt} (63%) create mode 120000 npa/doc/download.txt.in delete mode 120000 npa/doc/questions.rst.in rename virtualsmartcard/doc/questions.rst => npa/doc/questions.txt (91%) create mode 120000 npa/doc/questions.txt.in rename pcsc-relay/doc/{README.rst => README.txt} (78%) rename pcsc-relay/doc/{README.rst.in => README.txt.in} (58%) delete mode 120000 pcsc-relay/doc/autotools.rst.in rename pcsc-relay/doc/{autotools.rst => autotools.txt} (95%) create mode 120000 pcsc-relay/doc/autotools.txt.in delete mode 120000 pcsc-relay/doc/download.rst.in rename pcsc-relay/doc/{download.rst => download.txt} (62%) create mode 120000 pcsc-relay/doc/download.txt.in delete mode 120000 pcsc-relay/doc/questions.rst.in rename npa/doc/questions.rst => pcsc-relay/doc/questions.txt (91%) create mode 120000 pcsc-relay/doc/questions.txt.in rename virtualsmartcard/doc/{README.rst => README.txt} (86%) rename virtualsmartcard/doc/{README.rst.in => README.txt.in} (80%) rename virtualsmartcard/doc/{api.rst => api.txt} (100%) create mode 100644 virtualsmartcard/doc/api/virtualsmartcard.CardGenerator.txt create mode 100644 virtualsmartcard/doc/api/virtualsmartcard.ConstantDefinitions.txt create mode 100644 virtualsmartcard/doc/api/virtualsmartcard.CryptoUtils.txt create mode 100644 virtualsmartcard/doc/api/virtualsmartcard.SEutils.txt create mode 100644 virtualsmartcard/doc/api/virtualsmartcard.SWutils.txt create mode 100644 virtualsmartcard/doc/api/virtualsmartcard.SmartcardFilesystem.txt create mode 100644 virtualsmartcard/doc/api/virtualsmartcard.SmartcardSAM.txt create mode 100644 virtualsmartcard/doc/api/virtualsmartcard.TLVutils.txt create mode 100644 virtualsmartcard/doc/api/virtualsmartcard.VirtualSmartcard.txt create mode 100644 virtualsmartcard/doc/api/virtualsmartcard.cards.cryptoflex.txt create mode 100644 virtualsmartcard/doc/api/virtualsmartcard.cards.ePass.txt create mode 100644 virtualsmartcard/doc/api/virtualsmartcard.cards.nPA.txt create mode 100644 virtualsmartcard/doc/api/virtualsmartcard.cards.txt create mode 100644 virtualsmartcard/doc/api/virtualsmartcard.txt create mode 100644 virtualsmartcard/doc/api/virtualsmartcard.utils.txt delete mode 120000 virtualsmartcard/doc/autotools.rst.in rename virtualsmartcard/doc/{autotools.rst => autotools.txt} (95%) create mode 120000 virtualsmartcard/doc/autotools.txt.in delete mode 120000 virtualsmartcard/doc/download.rst.in rename virtualsmartcard/doc/{download.rst => download.txt} (63%) create mode 120000 virtualsmartcard/doc/download.txt.in delete mode 120000 virtualsmartcard/doc/questions.rst.in rename pcsc-relay/doc/questions.rst => virtualsmartcard/doc/questions.txt (91%) create mode 120000 virtualsmartcard/doc/questions.txt.in diff --git a/ccid/README b/ccid/README index 2ad76b7..253de0c 120000 --- a/ccid/README +++ b/ccid/README @@ -1 +1 @@ -doc/README.rst \ No newline at end of file +doc/README.txt \ No newline at end of file diff --git a/ccid/doc/Makefile.am b/ccid/doc/Makefile.am index 0a477e2..d31d6bf 100644 --- a/ccid/doc/Makefile.am +++ b/ccid/doc/Makefile.am @@ -16,13 +16,13 @@ do_subst = $(SED) \ -e 's,[@]abs_top_srcdir[@],$(abs_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 - $(do_subst) < autotools.rst.in > autotools.rst - $(do_subst) < questions.rst.in > questions.rst - $(do_subst) < download.rst.in > download.rst - $(do_subst) < README.rst.in > README.rst + $(do_subst) < autotools.txt.in > autotools.txt + $(do_subst) < questions.txt.in > questions.txt + $(do_subst) < download.txt.in > download.txt + $(do_subst) < README.txt.in > README.txt touch doc clean-local: diff --git a/ccid/doc/README.rst b/ccid/doc/README.txt similarity index 80% rename from ccid/doc/README.rst rename to ccid/doc/README.txt index 3fa7665..17ae239 100644 --- a/ccid/doc/README.rst +++ b/ccid/doc/README.txt @@ -1,17 +1,13 @@ .. 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` .. |PACE| replace:: :abbr:`PACE (Password Authenticated Connection Establishment)` .. _ccid-emulator: -******************************************************************************** +################# USB CCID Emulator -******************************************************************************** +################# :Author: Frank Morgner @@ -46,17 +42,15 @@ USB CCID PC/SC ================================== ============================================================ 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. -.. [#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. + +.. include:: download.txt -.. include:: download.rst - - -.. include:: autotools.rst +.. include:: autotools.txt 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. ------------------ +================= Hints on GadgetFS ------------------ +================= 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 -to run and compile GadgetFS_, you can find `here +to run and compile GadgetFS, you can find in the `OpenMoko Wiki `_. 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 `_. ---------------- +=============== Hints on OpenSC ---------------- +=============== 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 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 OPENSC=opensc @@ -112,12 +106,12 @@ configure the USB CCID Emulator to use it:: ./configure OPENSC_LIBS="-L$PREFIX/lib -lopensc" -===== +***** Usage -===== +***** 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 the `Windows USB CCID driver `_. To initialize @@ -126,4 +120,17 @@ and the `Windows USB CCID driver .. 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 diff --git a/ccid/doc/README.rst.in b/ccid/doc/README.txt.in similarity index 61% rename from ccid/doc/README.rst.in rename to ccid/doc/README.txt.in index f30711d..17ae239 100644 --- a/ccid/doc/README.rst.in +++ b/ccid/doc/README.txt.in @@ -1,17 +1,13 @@ .. 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` .. |PACE| replace:: :abbr:`PACE (Password Authenticated Connection Establishment)` .. _ccid-emulator: -******************************************************************************** -@PACKAGE_NAME@ -******************************************************************************** +################# +USB CCID Emulator +################# :Author: Frank Morgner @@ -20,21 +16,21 @@ :Tested Platforms: Linux (Debian, Ubuntu, OpenMoko) -The @PACKAGE_NAME@ forwards a locally present PC/SC smart card reader as a -standard USB CCID reader. @PACKAGE_NAME@ can be used as trusted intermediary +The USB CCID Emulator forwards a locally present PC/SC smart card reader as a +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| 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 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 card driver is required since USB CCID drivers are usually shipped with the 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: ================================== ============================================================ @@ -45,37 +41,35 @@ USB CCID PC/SC ``PC_to_RDR_Secure`` (proprietary) ``FEATURE_EXECUTE_PACE`` ================================== ============================================================ -The @PACKAGE_NAME@ is implemented using GadgetFS_. Some fragments of the source -code are based on the GadgetFS example and on the source code of the OpenSC_ +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 tools. -.. [#f1] Note that the heavily outdated `Windows USB CCID driver `_ 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 - -.. include:: autotools.rst - -Running the @PACKAGE_NAME@ has the following dependencies: +Running the USB CCID Emulator has the following dependencies: - Linux Kernel with GadgetFS_ - OpenSC_ - |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 modern Windows and Unix-like systems by default. ------------------ +================= Hints on GadgetFS ------------------ +================= 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 -to run and compile GadgetFS_, you can find `here +to run and compile GadgetFS, you can find in the `OpenMoko Wiki `_. 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 `_. ---------------- +=============== 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 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 OPENSC=opensc @@ -107,23 +101,36 @@ the standard installation of OpenSC_ without |PACE|:: make install 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" -===== +***** Usage -===== +***** -The @PACKAGE_NAME@ has various command line options to customize the appearance -on the USB host. In order to run the @PACKAGE_NAME@ GadgetFS_ must be loaded -and mounted. The @PACKAGE_NAME@ is compatible with the unix driver libccid_ +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 +and mounted. The USB CCID Emulator is compatible with the unix driver libccid_ and the `Windows USB CCID driver `_. To initialize |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 diff --git a/ccid/doc/autotools.rst.in b/ccid/doc/autotools.rst.in deleted file mode 120000 index 6c037f0..0000000 --- a/ccid/doc/autotools.rst.in +++ /dev/null @@ -1 +0,0 @@ -../../doc/autotools.rst.in \ No newline at end of file diff --git a/ccid/doc/autotools.rst b/ccid/doc/autotools.txt similarity index 95% rename from ccid/doc/autotools.rst rename to ccid/doc/autotools.txt index 2e50985..5a346c8 100644 --- a/ccid/doc/autotools.rst +++ b/ccid/doc/autotools.txt @@ -1,8 +1,8 @@ .. highlight:: sh -============ +************ Installation -============ +************ 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 diff --git a/ccid/doc/autotools.txt.in b/ccid/doc/autotools.txt.in new file mode 120000 index 0000000..25e76b8 --- /dev/null +++ b/ccid/doc/autotools.txt.in @@ -0,0 +1 @@ +../../doc/autotools.txt.in \ No newline at end of file diff --git a/ccid/doc/download.rst.in b/ccid/doc/download.rst.in deleted file mode 120000 index 30d6cb5..0000000 --- a/ccid/doc/download.rst.in +++ /dev/null @@ -1 +0,0 @@ -../../doc/download.rst.in \ No newline at end of file diff --git a/ccid/doc/download.txt b/ccid/doc/download.txt new file mode 100644 index 0000000..10a9249 --- /dev/null +++ b/ccid/doc/download.txt @@ -0,0 +1,12 @@ +.. highlight:: sh + +******** +Download +******** + +You can find the latest release of USB CCID Emulator `here +`_. + +Alternatively, you can clone our git repository:: + + git clone git://vsmartcard.git.sourceforge.net/gitroot/vsmartcard/vsmartcard diff --git a/ccid/doc/download.txt.in b/ccid/doc/download.txt.in new file mode 120000 index 0000000..8ac884d --- /dev/null +++ b/ccid/doc/download.txt.in @@ -0,0 +1 @@ +../../doc/download.txt.in \ No newline at end of file diff --git a/ccid/doc/questions.rst.in b/ccid/doc/questions.rst.in deleted file mode 120000 index 6b55a14..0000000 --- a/ccid/doc/questions.rst.in +++ /dev/null @@ -1 +0,0 @@ -../../doc/questions.rst.in \ No newline at end of file diff --git a/ccid/doc/questions.rst b/ccid/doc/questions.txt similarity index 91% rename from ccid/doc/questions.rst rename to ccid/doc/questions.txt index 7c84052..a3e7736 100644 --- a/ccid/doc/questions.rst +++ b/ccid/doc/questions.txt @@ -1,6 +1,6 @@ -======== +******** Question -======== +******** Do you have questions, suggestions or contributions? Feedback of any kind is more than welcome! Please use our `project trackers `_. diff --git a/ccid/doc/questions.txt.in b/ccid/doc/questions.txt.in new file mode 120000 index 0000000..1859aeb --- /dev/null +++ b/ccid/doc/questions.txt.in @@ -0,0 +1 @@ +../../doc/questions.txt.in \ No newline at end of file diff --git a/doc/autotools.rst.in b/doc/autotools.txt.in similarity index 95% rename from doc/autotools.rst.in rename to doc/autotools.txt.in index f032947..a42aabc 100644 --- a/doc/autotools.rst.in +++ b/doc/autotools.txt.in @@ -1,8 +1,8 @@ .. highlight:: sh -============ +************ Installation -============ +************ 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 diff --git a/doc/conf.py b/doc/conf.py index e7269cb..23fe392 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -41,7 +41,7 @@ extensions = ["breathe", "sphinxcontrib.doxylink", "sphinx.ext.autosummary", "sp templates_path = ['_templates'] # The suffix of source filenames. -source_suffix = '.rst' +source_suffix = '.txt' # The encoding of source files. #source_encoding = 'utf-8-sig' @@ -74,7 +74,7 @@ release = '2012-04-11' # List of patterns, relative to source directory, that match files and # 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. #default_role = None diff --git a/doc/download.rst.in b/doc/download.txt.in similarity index 62% rename from doc/download.rst.in rename to doc/download.txt.in index a683326..a59d903 100644 --- a/doc/download.rst.in +++ b/doc/download.txt.in @@ -1,8 +1,8 @@ .. highlight:: sh -=============================================================================== +******** Download -=============================================================================== +******** You can find the latest release of @PACKAGE_NAME@ `here `_. diff --git a/doc/index.rst b/doc/index.txt similarity index 100% rename from doc/index.rst rename to doc/index.txt diff --git a/doc/questions.rst.in b/doc/questions.txt.in similarity index 90% rename from doc/questions.rst.in rename to doc/questions.txt.in index e95d912..607ce2d 100644 --- a/doc/questions.rst.in +++ b/doc/questions.txt.in @@ -1,6 +1,6 @@ -======== +******** Question -======== +******** Do you have questions, suggestions or contributions? Feedback of any kind is more than welcome! Please use our `project trackers <@PACKAGE_BUGREPORT@>`_. diff --git a/npa/README b/npa/README index 2ad76b7..253de0c 120000 --- a/npa/README +++ b/npa/README @@ -1 +1 @@ -doc/README.rst \ No newline at end of file +doc/README.txt \ No newline at end of file diff --git a/npa/doc/Makefile.am b/npa/doc/Makefile.am index a68f52f..d7c97dc 100644 --- a/npa/doc/Makefile.am +++ b/npa/doc/Makefile.am @@ -16,18 +16,18 @@ do_subst = $(SED) \ -e 's,[@]abs_top_srcdir[@],$(abs_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 doc: $(top_srcdir)/src/npa/*.h *.in $(do_subst) < Doxyfile.in > Doxyfile $(DOXYGEN) Doxyfile - touch api.rst - $(do_subst) < autotools.rst.in > autotools.rst - $(do_subst) < questions.rst.in > questions.rst - $(do_subst) < download.rst.in > download.rst - $(do_subst) < README.rst.in > README.rst + touch api.txt + $(do_subst) < autotools.txt.in > autotools.txt + $(do_subst) < questions.txt.in > questions.txt + $(do_subst) < download.txt.in > download.txt + $(do_subst) < README.txt.in > README.txt touch doc clean-local: diff --git a/npa/doc/README.rst b/npa/doc/README.txt similarity index 86% rename from npa/doc/README.rst rename to npa/doc/README.txt index fe55916..d601a75 100644 --- a/npa/doc/README.rst +++ b/npa/doc/README.txt @@ -1,18 +1,14 @@ .. 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)` .. |npa-tool| replace:: :command:`npa-tool` .. _npa: -******************************************************************************** +###################### nPA Smart Card Library -******************************************************************************** +###################### :Author: Frank Morgner @@ -35,12 +31,12 @@ transparent SM usage in OpenSC. This allows nPA Smart Card Library to be fully compatible with OpenSC. -.. include:: download.rst +.. include:: download.txt .. _npa-install: -.. include:: autotools.rst +.. include:: autotools.txt The nPA Smart Card Library has the following dependencies: @@ -49,9 +45,9 @@ The nPA Smart Card Library has the following dependencies: - OpenSC_ ------------------------------------- +==================================== Installation of OpenPACE and OpenSSL ------------------------------------- +==================================== 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 @@ -69,13 +65,13 @@ the required binaries for OpenSSL):: The file :file:`libcrypto.pc` should be located in ``$INSTALL/lib/pkgconfig``. ----------------------- +====================== Installation of OpenSC ----------------------- +====================== 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 -of OpenSC_:: +of OpenSC:: 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``. --------------------------------------------------------------------------------- +========================================== Installation of the 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 ---------------------- -Following the section `Installation`_ above, you have installed OpenSSL_, -OpenPACE_, OpenSC_ and the nPA Smart Card Library to `$PREFIX` which points to +Following the section Installation_ above, you have installed OpenSSL, +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 the OpenSC header files, which are located in :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" -.. 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 diff --git a/npa/doc/README.rst.in b/npa/doc/README.txt.in similarity index 72% rename from npa/doc/README.rst.in rename to npa/doc/README.txt.in index eb4a024..d601a75 100644 --- a/npa/doc/README.rst.in +++ b/npa/doc/README.txt.in @@ -1,18 +1,14 @@ .. 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)` .. |npa-tool| replace:: :command:`npa-tool` .. _npa: -******************************************************************************** -@PACKAGE_NAME@ -******************************************************************************** +###################### +nPA Smart Card Library +###################### :Author: Frank Morgner @@ -24,36 +20,36 @@ :Potential Platforms: 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, 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. -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 -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. -.. include:: download.rst +.. include:: download.txt .. _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_ - OpenPACE_ - OpenSC_ ------------------------------------- +==================================== 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 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``. ----------------------- +====================== 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 -of OpenSC_:: +of OpenSC:: 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``. --------------------------------------------------------------------------------- -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 autoreconf --verbose --install @@ -127,9 +123,9 @@ be found in :file:`apdus`. Linking against libnpa ---------------------- -Following the section `Installation`_ above, you have installed OpenSSL_, -OpenPACE_, OpenSC_ and the @PACKAGE_NAME@ to `$PREFIX` which points to -:file:`/tmp/install`. To compile a program using @PACKAGE_NAME@ you also need +Following the section Installation_ above, you have installed OpenSSL, +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 the OpenSC header files, which are located in :file:`$VSMARTCARD/npa/src/opensc` Here is how to compile an external program with these libraries:: @@ -145,4 +141,15 @@ Alternatively you can specify libraries and flags by hand:: -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 diff --git a/npa/doc/api.rst b/npa/doc/api.txt similarity index 100% rename from npa/doc/api.rst rename to npa/doc/api.txt diff --git a/npa/doc/autotools.rst.in b/npa/doc/autotools.rst.in deleted file mode 120000 index 6c037f0..0000000 --- a/npa/doc/autotools.rst.in +++ /dev/null @@ -1 +0,0 @@ -../../doc/autotools.rst.in \ No newline at end of file diff --git a/npa/doc/autotools.rst b/npa/doc/autotools.txt similarity index 95% rename from npa/doc/autotools.rst rename to npa/doc/autotools.txt index dd4428d..5142504 100644 --- a/npa/doc/autotools.rst +++ b/npa/doc/autotools.txt @@ -1,8 +1,8 @@ .. highlight:: sh -============ +************ Installation -============ +************ 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 diff --git a/npa/doc/autotools.txt.in b/npa/doc/autotools.txt.in new file mode 120000 index 0000000..25e76b8 --- /dev/null +++ b/npa/doc/autotools.txt.in @@ -0,0 +1 @@ +../../doc/autotools.txt.in \ No newline at end of file diff --git a/npa/doc/download.rst.in b/npa/doc/download.rst.in deleted file mode 120000 index 30d6cb5..0000000 --- a/npa/doc/download.rst.in +++ /dev/null @@ -1 +0,0 @@ -../../doc/download.rst.in \ No newline at end of file diff --git a/npa/doc/download.rst b/npa/doc/download.txt similarity index 63% rename from npa/doc/download.rst rename to npa/doc/download.txt index 6bb6b21..26474d6 100644 --- a/npa/doc/download.rst +++ b/npa/doc/download.txt @@ -1,8 +1,8 @@ .. highlight:: sh -=============================================================================== +******** Download -=============================================================================== +******** You can find the latest release of nPA Smart Card Library `here `_. diff --git a/npa/doc/download.txt.in b/npa/doc/download.txt.in new file mode 120000 index 0000000..8ac884d --- /dev/null +++ b/npa/doc/download.txt.in @@ -0,0 +1 @@ +../../doc/download.txt.in \ No newline at end of file diff --git a/npa/doc/questions.rst.in b/npa/doc/questions.rst.in deleted file mode 120000 index 6b55a14..0000000 --- a/npa/doc/questions.rst.in +++ /dev/null @@ -1 +0,0 @@ -../../doc/questions.rst.in \ No newline at end of file diff --git a/virtualsmartcard/doc/questions.rst b/npa/doc/questions.txt similarity index 91% rename from virtualsmartcard/doc/questions.rst rename to npa/doc/questions.txt index 7c84052..a3e7736 100644 --- a/virtualsmartcard/doc/questions.rst +++ b/npa/doc/questions.txt @@ -1,6 +1,6 @@ -======== +******** Question -======== +******** Do you have questions, suggestions or contributions? Feedback of any kind is more than welcome! Please use our `project trackers `_. diff --git a/npa/doc/questions.txt.in b/npa/doc/questions.txt.in new file mode 120000 index 0000000..1859aeb --- /dev/null +++ b/npa/doc/questions.txt.in @@ -0,0 +1 @@ +../../doc/questions.txt.in \ No newline at end of file diff --git a/pcsc-relay/README b/pcsc-relay/README index 2ad76b7..253de0c 120000 --- a/pcsc-relay/README +++ b/pcsc-relay/README @@ -1 +1 @@ -doc/README.rst \ No newline at end of file +doc/README.txt \ No newline at end of file diff --git a/pcsc-relay/doc/Makefile.am b/pcsc-relay/doc/Makefile.am index 98dd4ef..587bbbe 100644 --- a/pcsc-relay/doc/Makefile.am +++ b/pcsc-relay/doc/Makefile.am @@ -16,13 +16,13 @@ do_subst = $(SED) \ -e 's,[@]abs_top_srcdir[@],$(abs_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 - $(do_subst) < autotools.rst.in > autotools.rst - $(do_subst) < questions.rst.in > questions.rst - $(do_subst) < download.rst.in > download.rst - $(do_subst) < README.rst.in > README.rst + $(do_subst) < autotools.txt.in > autotools.txt + $(do_subst) < questions.txt.in > questions.txt + $(do_subst) < download.txt.in > download.txt + $(do_subst) < README.txt.in > README.txt touch doc clean-local: diff --git a/pcsc-relay/doc/README.rst b/pcsc-relay/doc/README.txt similarity index 78% rename from pcsc-relay/doc/README.rst rename to pcsc-relay/doc/README.txt index a16f080..f83aa1b 100644 --- a/pcsc-relay/doc/README.rst +++ b/pcsc-relay/doc/README.txt @@ -1,14 +1,10 @@ .. highlight:: sh -.. _libnfc: http://www.libnfc.org/ -.. _OpenPICC: http://www.openpcd.org/OpenPICC -.. _PCSC-lite: http://pcsclite.alioth.debian.org/ - .. _pcsc-relay: -******************************************************************************** +########### PC/SC Relay -******************************************************************************** +########### :Authors: - Frank Morgner @@ -35,25 +31,24 @@ emulate an ISO/IEC 14443 smart card. .. note:: 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 - card - `_, - but it generally concerns *all* contact-less smart cards. + 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. -.. include:: download.rst +.. include:: download.txt -.. include:: autotools.rst +.. include:: autotools.txt PC/SC Relay has the following dependencies: - PC/SC middleware - libnfc_ ---------------- +=============== Hints on libnfc ---------------- +=============== PC/SC Relay links against libnfc_. Here is an example of how to get the standard installation of the latter:: @@ -74,9 +69,9 @@ configure PC/SC Relay to use it:: ./configure PKG_CONFIG_PATH=$PREFIX/lib/pkgconfig -------------------------- +========================= 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 @@ -88,11 +83,23 @@ Microsoft's developement environment Visual Studio includes all necessary data for building PC/SC Relay. -===== +***** Usage -===== +***** .. 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 diff --git a/pcsc-relay/doc/README.rst.in b/pcsc-relay/doc/README.txt.in similarity index 58% rename from pcsc-relay/doc/README.rst.in rename to pcsc-relay/doc/README.txt.in index 2624c50..f83aa1b 100644 --- a/pcsc-relay/doc/README.rst.in +++ b/pcsc-relay/doc/README.txt.in @@ -1,14 +1,10 @@ .. highlight:: sh -.. _libnfc: http://www.libnfc.org/ -.. _OpenPICC: http://www.openpcd.org/OpenPICC -.. _PCSC-lite: http://pcsclite.alioth.debian.org/ - .. _pcsc-relay: -******************************************************************************** -@PACKAGE_NAME@ -******************************************************************************** +########### +PC/SC Relay +########### :Authors: - Frank Morgner @@ -21,7 +17,7 @@ :Potential Platforms: 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 backends: @@ -30,32 +26,31 @@ backends: 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 @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. .. note:: 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 - card - `_, - but it generally concerns *all* contact-less smart cards. + 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. -.. 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 - 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:: PREFIX=/tmp/install @@ -67,32 +62,44 @@ installation of the latter:: make 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 -configure @PACKAGE_NAME@ to use it:: +configure PC/SC Relay to use it:: ./configure PKG_CONFIG_PATH=$PREFIX/lib/pkgconfig -------------------------- +========================= 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 @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. 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 @PACKAGE_NAME@. +for building PC/SC Relay. -===== +***** 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 diff --git a/pcsc-relay/doc/autotools.rst.in b/pcsc-relay/doc/autotools.rst.in deleted file mode 120000 index 6c037f0..0000000 --- a/pcsc-relay/doc/autotools.rst.in +++ /dev/null @@ -1 +0,0 @@ -../../doc/autotools.rst.in \ No newline at end of file diff --git a/pcsc-relay/doc/autotools.rst b/pcsc-relay/doc/autotools.txt similarity index 95% rename from pcsc-relay/doc/autotools.rst rename to pcsc-relay/doc/autotools.txt index f97bec1..5449914 100644 --- a/pcsc-relay/doc/autotools.rst +++ b/pcsc-relay/doc/autotools.txt @@ -1,8 +1,8 @@ .. highlight:: sh -============ +************ 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 diff --git a/pcsc-relay/doc/autotools.txt.in b/pcsc-relay/doc/autotools.txt.in new file mode 120000 index 0000000..25e76b8 --- /dev/null +++ b/pcsc-relay/doc/autotools.txt.in @@ -0,0 +1 @@ +../../doc/autotools.txt.in \ No newline at end of file diff --git a/pcsc-relay/doc/download.rst.in b/pcsc-relay/doc/download.rst.in deleted file mode 120000 index 30d6cb5..0000000 --- a/pcsc-relay/doc/download.rst.in +++ /dev/null @@ -1 +0,0 @@ -../../doc/download.rst.in \ No newline at end of file diff --git a/pcsc-relay/doc/download.rst b/pcsc-relay/doc/download.txt similarity index 62% rename from pcsc-relay/doc/download.rst rename to pcsc-relay/doc/download.txt index 54f3d35..39cbb4e 100644 --- a/pcsc-relay/doc/download.rst +++ b/pcsc-relay/doc/download.txt @@ -1,8 +1,8 @@ .. highlight:: sh -=============================================================================== +******** Download -=============================================================================== +******** You can find the latest release of PC/SC Relay `here `_. diff --git a/pcsc-relay/doc/download.txt.in b/pcsc-relay/doc/download.txt.in new file mode 120000 index 0000000..8ac884d --- /dev/null +++ b/pcsc-relay/doc/download.txt.in @@ -0,0 +1 @@ +../../doc/download.txt.in \ No newline at end of file diff --git a/pcsc-relay/doc/questions.rst.in b/pcsc-relay/doc/questions.rst.in deleted file mode 120000 index 6b55a14..0000000 --- a/pcsc-relay/doc/questions.rst.in +++ /dev/null @@ -1 +0,0 @@ -../../doc/questions.rst.in \ No newline at end of file diff --git a/npa/doc/questions.rst b/pcsc-relay/doc/questions.txt similarity index 91% rename from npa/doc/questions.rst rename to pcsc-relay/doc/questions.txt index 7c84052..a3e7736 100644 --- a/npa/doc/questions.rst +++ b/pcsc-relay/doc/questions.txt @@ -1,6 +1,6 @@ -======== +******** Question -======== +******** Do you have questions, suggestions or contributions? Feedback of any kind is more than welcome! Please use our `project trackers `_. diff --git a/pcsc-relay/doc/questions.txt.in b/pcsc-relay/doc/questions.txt.in new file mode 120000 index 0000000..1859aeb --- /dev/null +++ b/pcsc-relay/doc/questions.txt.in @@ -0,0 +1 @@ +../../doc/questions.txt.in \ No newline at end of file diff --git a/virtualsmartcard/README b/virtualsmartcard/README index 2ad76b7..253de0c 120000 --- a/virtualsmartcard/README +++ b/virtualsmartcard/README @@ -1 +1 @@ -doc/README.rst \ No newline at end of file +doc/README.txt \ No newline at end of file diff --git a/virtualsmartcard/doc/Makefile.am b/virtualsmartcard/doc/Makefile.am index 0df25e7..6583b97 100644 --- a/virtualsmartcard/doc/Makefile.am +++ b/virtualsmartcard/doc/Makefile.am @@ -17,16 +17,16 @@ do_subst = $(SED) \ -e 's,[@]abs_top_srcdir[@],$(abs_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 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) < questions.rst.in > questions.rst - $(do_subst) < download.rst.in > download.rst - $(do_subst) < README.rst.in > README.rst - ./generate_modules.py $(top_srcdir)/src/vpicc --dest-dir=api --suffix=rst --no-toc -1 -f + $(do_subst) < autotools.txt.in > autotools.txt + $(do_subst) < questions.txt.in > questions.txt + $(do_subst) < download.txt.in > download.txt + $(do_subst) < README.txt.in > README.txt + ./generate_modules.py $(top_srcdir)/src/vpicc --dest-dir=api --suffix=txt --no-toc -1 -f touch doc clean-local: diff --git a/virtualsmartcard/doc/README.rst b/virtualsmartcard/doc/README.txt similarity index 86% rename from virtualsmartcard/doc/README.rst rename to virtualsmartcard/doc/README.txt index 5fd3ff3..bd9a99a 100644 --- a/virtualsmartcard/doc/README.rst +++ b/virtualsmartcard/doc/README.txt @@ -1,14 +1,5 @@ .. 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)` .. |vpcd| replace:: :abbr:`vpcd (virtual smart card reader)` .. |EAC| replace:: :abbr:`EAC (Extended Access Control)` @@ -19,9 +10,9 @@ .. _vicc: -******************************************************************************** +################## Virtual Smart Card -******************************************************************************** +################## :Authors: - Frank Morgner @@ -55,10 +46,10 @@ reader. 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 the following: @@ -72,11 +63,11 @@ the following: The |vpcd| depends on PCSC-Lite_. -================================================================================ +****************************** 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. Then :command:`pcscd -f -d` should say something like "Attempting startup of 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 :command:`pcsc_scan` for testing. --------------------------------------------------------------------------------- + +========================================================== Accessing the Virtual Smart Card from Windows applications --------------------------------------------------------------------------------- +========================================================== Running |vpcd| under Windows is currently not supported, because it implements 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. -.. 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/ diff --git a/virtualsmartcard/doc/README.rst.in b/virtualsmartcard/doc/README.txt.in similarity index 80% rename from virtualsmartcard/doc/README.rst.in rename to virtualsmartcard/doc/README.txt.in index 5ad3cce..bd9a99a 100644 --- a/virtualsmartcard/doc/README.rst.in +++ b/virtualsmartcard/doc/README.txt.in @@ -1,14 +1,5 @@ .. 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)` .. |vpcd| replace:: :abbr:`vpcd (virtual smart card reader)` .. |EAC| replace:: :abbr:`EAC (Extended Access Control)` @@ -19,9 +10,9 @@ .. _vicc: -******************************************************************************** -@PACKAGE_NAME@ -******************************************************************************** +################## +Virtual Smart Card +################## :Authors: - Frank Morgner @@ -34,8 +25,8 @@ :Potential Platforms: Unix-like operating systems (Mac OS, Solaris, BSD, ...) -@PACKAGE_NAME@ emulates a smart card and makes it accessible through PC/SC. -Currently the @PACKAGE_NAME@ supports the following types of smart cards: +Virtual Smart Card emulates a smart card and makes it accessible through PC/SC. +Currently the Virtual Smart Card supports the following types of smart cards: - Generic ISO-7816 smart card including secure messaging - 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|, 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 reader. 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 the following: @@ -72,11 +63,11 @@ the following: 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. Then :command:`pcscd -f -d` should say something like "Attempting startup of 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 :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 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. -.. 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/ diff --git a/virtualsmartcard/doc/api.rst b/virtualsmartcard/doc/api.txt similarity index 100% rename from virtualsmartcard/doc/api.rst rename to virtualsmartcard/doc/api.txt diff --git a/virtualsmartcard/doc/api/virtualsmartcard.CardGenerator.txt b/virtualsmartcard/doc/api/virtualsmartcard.CardGenerator.txt new file mode 100644 index 0000000..867d6e1 --- /dev/null +++ b/virtualsmartcard/doc/api/virtualsmartcard.CardGenerator.txt @@ -0,0 +1,10 @@ +CardGenerator Module +==================== + +.. inheritance-diagram:: virtualsmartcard.CardGenerator +.. automodule:: virtualsmartcard.CardGenerator + :members: + :undoc-members: + :inherited-members: + :show-inheritance: + :private-members: diff --git a/virtualsmartcard/doc/api/virtualsmartcard.ConstantDefinitions.txt b/virtualsmartcard/doc/api/virtualsmartcard.ConstantDefinitions.txt new file mode 100644 index 0000000..a80f86b --- /dev/null +++ b/virtualsmartcard/doc/api/virtualsmartcard.ConstantDefinitions.txt @@ -0,0 +1,10 @@ +ConstantDefinitions Module +========================== + +.. inheritance-diagram:: virtualsmartcard.ConstantDefinitions +.. automodule:: virtualsmartcard.ConstantDefinitions + :members: + :undoc-members: + :inherited-members: + :show-inheritance: + :private-members: diff --git a/virtualsmartcard/doc/api/virtualsmartcard.CryptoUtils.txt b/virtualsmartcard/doc/api/virtualsmartcard.CryptoUtils.txt new file mode 100644 index 0000000..8a686c9 --- /dev/null +++ b/virtualsmartcard/doc/api/virtualsmartcard.CryptoUtils.txt @@ -0,0 +1,10 @@ +CryptoUtils Module +================== + +.. inheritance-diagram:: virtualsmartcard.CryptoUtils +.. automodule:: virtualsmartcard.CryptoUtils + :members: + :undoc-members: + :inherited-members: + :show-inheritance: + :private-members: diff --git a/virtualsmartcard/doc/api/virtualsmartcard.SEutils.txt b/virtualsmartcard/doc/api/virtualsmartcard.SEutils.txt new file mode 100644 index 0000000..667a56b --- /dev/null +++ b/virtualsmartcard/doc/api/virtualsmartcard.SEutils.txt @@ -0,0 +1,10 @@ +SEutils Module +============== + +.. inheritance-diagram:: virtualsmartcard.SEutils +.. automodule:: virtualsmartcard.SEutils + :members: + :undoc-members: + :inherited-members: + :show-inheritance: + :private-members: diff --git a/virtualsmartcard/doc/api/virtualsmartcard.SWutils.txt b/virtualsmartcard/doc/api/virtualsmartcard.SWutils.txt new file mode 100644 index 0000000..0c894a9 --- /dev/null +++ b/virtualsmartcard/doc/api/virtualsmartcard.SWutils.txt @@ -0,0 +1,10 @@ +SWutils Module +============== + +.. inheritance-diagram:: virtualsmartcard.SWutils +.. automodule:: virtualsmartcard.SWutils + :members: + :undoc-members: + :inherited-members: + :show-inheritance: + :private-members: diff --git a/virtualsmartcard/doc/api/virtualsmartcard.SmartcardFilesystem.txt b/virtualsmartcard/doc/api/virtualsmartcard.SmartcardFilesystem.txt new file mode 100644 index 0000000..4f5e13b --- /dev/null +++ b/virtualsmartcard/doc/api/virtualsmartcard.SmartcardFilesystem.txt @@ -0,0 +1,10 @@ +SmartcardFilesystem Module +========================== + +.. inheritance-diagram:: virtualsmartcard.SmartcardFilesystem +.. automodule:: virtualsmartcard.SmartcardFilesystem + :members: + :undoc-members: + :inherited-members: + :show-inheritance: + :private-members: diff --git a/virtualsmartcard/doc/api/virtualsmartcard.SmartcardSAM.txt b/virtualsmartcard/doc/api/virtualsmartcard.SmartcardSAM.txt new file mode 100644 index 0000000..95c902d --- /dev/null +++ b/virtualsmartcard/doc/api/virtualsmartcard.SmartcardSAM.txt @@ -0,0 +1,10 @@ +SmartcardSAM Module +=================== + +.. inheritance-diagram:: virtualsmartcard.SmartcardSAM +.. automodule:: virtualsmartcard.SmartcardSAM + :members: + :undoc-members: + :inherited-members: + :show-inheritance: + :private-members: diff --git a/virtualsmartcard/doc/api/virtualsmartcard.TLVutils.txt b/virtualsmartcard/doc/api/virtualsmartcard.TLVutils.txt new file mode 100644 index 0000000..20ac430 --- /dev/null +++ b/virtualsmartcard/doc/api/virtualsmartcard.TLVutils.txt @@ -0,0 +1,10 @@ +TLVutils Module +=============== + +.. inheritance-diagram:: virtualsmartcard.TLVutils +.. automodule:: virtualsmartcard.TLVutils + :members: + :undoc-members: + :inherited-members: + :show-inheritance: + :private-members: diff --git a/virtualsmartcard/doc/api/virtualsmartcard.VirtualSmartcard.txt b/virtualsmartcard/doc/api/virtualsmartcard.VirtualSmartcard.txt new file mode 100644 index 0000000..935119f --- /dev/null +++ b/virtualsmartcard/doc/api/virtualsmartcard.VirtualSmartcard.txt @@ -0,0 +1,10 @@ +VirtualSmartcard Module +======================= + +.. inheritance-diagram:: virtualsmartcard.VirtualSmartcard +.. automodule:: virtualsmartcard.VirtualSmartcard + :members: + :undoc-members: + :inherited-members: + :show-inheritance: + :private-members: diff --git a/virtualsmartcard/doc/api/virtualsmartcard.cards.cryptoflex.txt b/virtualsmartcard/doc/api/virtualsmartcard.cards.cryptoflex.txt new file mode 100644 index 0000000..d907dc8 --- /dev/null +++ b/virtualsmartcard/doc/api/virtualsmartcard.cards.cryptoflex.txt @@ -0,0 +1,10 @@ +cryptoflex Module +================= + +.. inheritance-diagram:: virtualsmartcard.cards.cryptoflex +.. automodule:: virtualsmartcard.cards.cryptoflex + :members: + :undoc-members: + :inherited-members: + :show-inheritance: + :private-members: diff --git a/virtualsmartcard/doc/api/virtualsmartcard.cards.ePass.txt b/virtualsmartcard/doc/api/virtualsmartcard.cards.ePass.txt new file mode 100644 index 0000000..fc5e065 --- /dev/null +++ b/virtualsmartcard/doc/api/virtualsmartcard.cards.ePass.txt @@ -0,0 +1,10 @@ +ePass Module +============ + +.. inheritance-diagram:: virtualsmartcard.cards.ePass +.. automodule:: virtualsmartcard.cards.ePass + :members: + :undoc-members: + :inherited-members: + :show-inheritance: + :private-members: diff --git a/virtualsmartcard/doc/api/virtualsmartcard.cards.nPA.txt b/virtualsmartcard/doc/api/virtualsmartcard.cards.nPA.txt new file mode 100644 index 0000000..cb03e69 --- /dev/null +++ b/virtualsmartcard/doc/api/virtualsmartcard.cards.nPA.txt @@ -0,0 +1,10 @@ +nPA Module +========== + +.. inheritance-diagram:: virtualsmartcard.cards.nPA +.. automodule:: virtualsmartcard.cards.nPA + :members: + :undoc-members: + :inherited-members: + :show-inheritance: + :private-members: diff --git a/virtualsmartcard/doc/api/virtualsmartcard.cards.txt b/virtualsmartcard/doc/api/virtualsmartcard.cards.txt new file mode 100644 index 0000000..b9468ea --- /dev/null +++ b/virtualsmartcard/doc/api/virtualsmartcard.cards.txt @@ -0,0 +1,9 @@ +cards Package +============= + +.. toctree:: + + virtualsmartcard.cards.cryptoflex + virtualsmartcard.cards.ePass + virtualsmartcard.cards.nPA + diff --git a/virtualsmartcard/doc/api/virtualsmartcard.txt b/virtualsmartcard/doc/api/virtualsmartcard.txt new file mode 100644 index 0000000..d9e1d02 --- /dev/null +++ b/virtualsmartcard/doc/api/virtualsmartcard.txt @@ -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 + diff --git a/virtualsmartcard/doc/api/virtualsmartcard.utils.txt b/virtualsmartcard/doc/api/virtualsmartcard.utils.txt new file mode 100644 index 0000000..342c3a3 --- /dev/null +++ b/virtualsmartcard/doc/api/virtualsmartcard.utils.txt @@ -0,0 +1,10 @@ +utils Module +============ + +.. inheritance-diagram:: virtualsmartcard.utils +.. automodule:: virtualsmartcard.utils + :members: + :undoc-members: + :inherited-members: + :show-inheritance: + :private-members: diff --git a/virtualsmartcard/doc/autotools.rst.in b/virtualsmartcard/doc/autotools.rst.in deleted file mode 120000 index 6c037f0..0000000 --- a/virtualsmartcard/doc/autotools.rst.in +++ /dev/null @@ -1 +0,0 @@ -../../doc/autotools.rst.in \ No newline at end of file diff --git a/virtualsmartcard/doc/autotools.rst b/virtualsmartcard/doc/autotools.txt similarity index 95% rename from virtualsmartcard/doc/autotools.rst rename to virtualsmartcard/doc/autotools.txt index 9d9d0a3..bbc0609 100644 --- a/virtualsmartcard/doc/autotools.rst +++ b/virtualsmartcard/doc/autotools.txt @@ -1,8 +1,8 @@ .. highlight:: sh -============ +************ Installation -============ +************ 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 diff --git a/virtualsmartcard/doc/autotools.txt.in b/virtualsmartcard/doc/autotools.txt.in new file mode 120000 index 0000000..25e76b8 --- /dev/null +++ b/virtualsmartcard/doc/autotools.txt.in @@ -0,0 +1 @@ +../../doc/autotools.txt.in \ No newline at end of file diff --git a/virtualsmartcard/doc/download.rst.in b/virtualsmartcard/doc/download.rst.in deleted file mode 120000 index 30d6cb5..0000000 --- a/virtualsmartcard/doc/download.rst.in +++ /dev/null @@ -1 +0,0 @@ -../../doc/download.rst.in \ No newline at end of file diff --git a/virtualsmartcard/doc/download.rst b/virtualsmartcard/doc/download.txt similarity index 63% rename from virtualsmartcard/doc/download.rst rename to virtualsmartcard/doc/download.txt index d6dd4d4..ed16e34 100644 --- a/virtualsmartcard/doc/download.rst +++ b/virtualsmartcard/doc/download.txt @@ -1,8 +1,8 @@ .. highlight:: sh -=============================================================================== +******** Download -=============================================================================== +******** You can find the latest release of Virtual Smart Card `here `_. diff --git a/virtualsmartcard/doc/download.txt.in b/virtualsmartcard/doc/download.txt.in new file mode 120000 index 0000000..8ac884d --- /dev/null +++ b/virtualsmartcard/doc/download.txt.in @@ -0,0 +1 @@ +../../doc/download.txt.in \ No newline at end of file diff --git a/virtualsmartcard/doc/questions.rst.in b/virtualsmartcard/doc/questions.rst.in deleted file mode 120000 index 6b55a14..0000000 --- a/virtualsmartcard/doc/questions.rst.in +++ /dev/null @@ -1 +0,0 @@ -../../doc/questions.rst.in \ No newline at end of file diff --git a/pcsc-relay/doc/questions.rst b/virtualsmartcard/doc/questions.txt similarity index 91% rename from pcsc-relay/doc/questions.rst rename to virtualsmartcard/doc/questions.txt index 7c84052..a3e7736 100644 --- a/pcsc-relay/doc/questions.rst +++ b/virtualsmartcard/doc/questions.txt @@ -1,6 +1,6 @@ -======== +******** Question -======== +******** Do you have questions, suggestions or contributions? Feedback of any kind is more than welcome! Please use our `project trackers `_. diff --git a/virtualsmartcard/doc/questions.txt.in b/virtualsmartcard/doc/questions.txt.in new file mode 120000 index 0000000..1859aeb --- /dev/null +++ b/virtualsmartcard/doc/questions.txt.in @@ -0,0 +1 @@ +../../doc/questions.txt.in \ No newline at end of file