From b27126e4509adcaec747d3ee17f9134c6a3b4c4f Mon Sep 17 00:00:00 2001 From: Frank Morgner Date: Thu, 20 Nov 2014 21:25:31 +0100 Subject: [PATCH] updated documentation --- ccid/doc/README.txt.in | 12 ++++----- doc/autotools.txt.in | 5 ++++ doc/download.txt.in | 4 ++- doc/index.txt | 4 ++- npa/doc/README.txt | 12 ++++----- npa/doc/README.txt.in | 12 ++++----- npa/doc/autotools.txt | 5 ++++ npa/doc/download.txt | 4 ++- pcsc-relay/doc/README.txt | 8 +++--- pcsc-relay/doc/README.txt.in | 8 +++--- pcsc-relay/doc/autotools.txt | 5 ++++ pcsc-relay/doc/download.txt | 4 ++- virtualsmartcard/doc/README.txt | 42 ++++++++++++++++-------------- virtualsmartcard/doc/README.txt.in | 39 ++++++++++++++------------- virtualsmartcard/doc/autotools.txt | 5 ++++ virtualsmartcard/doc/download.txt | 4 ++- 16 files changed, 102 insertions(+), 71 deletions(-) diff --git a/ccid/doc/README.txt.in b/ccid/doc/README.txt.in index 2178224..1a07db2 100644 --- a/ccid/doc/README.txt.in +++ b/ccid/doc/README.txt.in @@ -126,12 +126,6 @@ tools. \texttt{/dev/gadget/ep3-bulk}\\}; - -.. include:: download.txt - - -.. include:: autotools.txt - Running the @PACKAGE_NAME@ has the following dependencies: - Linux Kernel with GadgetFS_ @@ -143,6 +137,12 @@ needs a usable PC/SC middleware with USB CCID driver. This is the case for most modern Windows and Unix-like systems by default. +.. include:: download.txt + + +.. include:: autotools.txt + + ================= Hints on GadgetFS ================= diff --git a/doc/autotools.txt.in b/doc/autotools.txt.in index 87a9d40..2ef333d 100644 --- a/doc/autotools.txt.in +++ b/doc/autotools.txt.in @@ -4,6 +4,11 @@ Installation ************ + +======================================= +Installation on Linux, Unix and similar +======================================= + 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 can not find it, you are probably working bleeding edge in the repository. Run the diff --git a/doc/download.txt.in b/doc/download.txt.in index df7244c..f5ae827 100644 --- a/doc/download.txt.in +++ b/doc/download.txt.in @@ -4,7 +4,9 @@ Download ******** -You can find the latest release of @PACKAGE_NAME@ on `Sourceforge +You can find the latest release of @PACKAGE_NAME@ on `Github +`_. Older releases are +still available on `Sourceforge `_. Alternatively, you can clone our git repository:: diff --git a/doc/index.txt b/doc/index.txt index c2db5e3..d3f91f0 100644 --- a/doc/index.txt +++ b/doc/index.txt @@ -332,7 +332,9 @@ Download -------- You can download the latest release of the |vsmartcard| `here -`_. +`_. Older releases are +still available at the `old project +location `_. Alternatively, you can clone our git repository:: diff --git a/npa/doc/README.txt b/npa/doc/README.txt index 942e344..fb06fe8 100644 --- a/npa/doc/README.txt +++ b/npa/doc/README.txt @@ -59,6 +59,12 @@ compatible with OpenSC. (libnpa) edge (openpace); \end{pgfonlayer} +The nPA Smart Card Library has the following dependencies: + +- OpenPACE_ +- OpenSC_ +- OpenSSL_ + .. include:: download.txt @@ -67,12 +73,6 @@ compatible with OpenSC. .. include:: autotools.txt -The nPA Smart Card Library has the following dependencies: - -- OpenPACE_ -- OpenSC_ -- OpenSSL_ - ==================================== Installation of OpenPACE and OpenSSL diff --git a/npa/doc/README.txt.in b/npa/doc/README.txt.in index 4903fa9..530f151 100644 --- a/npa/doc/README.txt.in +++ b/npa/doc/README.txt.in @@ -59,6 +59,12 @@ compatible with OpenSC. (libnpa) edge (openpace); \end{pgfonlayer} +The @PACKAGE_NAME@ has the following dependencies: + +- OpenPACE_ +- OpenSC_ +- OpenSSL_ + .. include:: download.txt @@ -67,12 +73,6 @@ compatible with OpenSC. .. include:: autotools.txt -The @PACKAGE_NAME@ has the following dependencies: - -- OpenPACE_ -- OpenSC_ -- OpenSSL_ - ==================================== Installation of OpenPACE and OpenSSL diff --git a/npa/doc/autotools.txt b/npa/doc/autotools.txt index 74b6100..25b430e 100644 --- a/npa/doc/autotools.txt +++ b/npa/doc/autotools.txt @@ -4,6 +4,11 @@ Installation ************ + +======================================= +Installation on Linux, Unix and similar +======================================= + 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 can not find it, you are probably working bleeding edge in the repository. Run the diff --git a/npa/doc/download.txt b/npa/doc/download.txt index af5e120..7f768e6 100644 --- a/npa/doc/download.txt +++ b/npa/doc/download.txt @@ -4,7 +4,9 @@ Download ******** -You can find the latest release of nPA Smart Card Library on `Sourceforge +You can find the latest release of nPA Smart Card Library on `Github +`_. Older releases are +still available on `Sourceforge `_. Alternatively, you can clone our git repository:: diff --git a/pcsc-relay/doc/README.txt b/pcsc-relay/doc/README.txt index 0179aa4..d1ae7b7 100644 --- a/pcsc-relay/doc/README.txt +++ b/pcsc-relay/doc/README.txt @@ -40,6 +40,10 @@ With PC/SC Relay you can relay a contact-less or contact based smart card over a long distance. Also you can use it in combination with the :ref:`vicc` to completely emulate an ISO/IEC 14443 smart card. +PC/SC Relay has the following dependencies: + +- PC/SC middleware +- libnfc_ .. include:: relay-note.txt @@ -50,10 +54,6 @@ to completely emulate an ISO/IEC 14443 smart card. .. include:: autotools.txt -PC/SC Relay has the following dependencies: - -- PC/SC middleware -- libnfc_ =============== Hints on libnfc diff --git a/pcsc-relay/doc/README.txt.in b/pcsc-relay/doc/README.txt.in index 196d268..4d72779 100644 --- a/pcsc-relay/doc/README.txt.in +++ b/pcsc-relay/doc/README.txt.in @@ -40,6 +40,10 @@ With @PACKAGE_NAME@ you can relay a contact-less or contact based smart card over a long distance. Also you can use it in combination with the :ref:`vicc` to completely emulate an ISO/IEC 14443 smart card. +@PACKAGE_NAME@ has the following dependencies: + +- PC/SC middleware +- libnfc_ .. include:: relay-note.txt @@ -50,10 +54,6 @@ to completely emulate an ISO/IEC 14443 smart card. .. include:: autotools.txt -@PACKAGE_NAME@ has the following dependencies: - -- PC/SC middleware -- libnfc_ =============== Hints on libnfc diff --git a/pcsc-relay/doc/autotools.txt b/pcsc-relay/doc/autotools.txt index 1907566..45a7f53 100644 --- a/pcsc-relay/doc/autotools.txt +++ b/pcsc-relay/doc/autotools.txt @@ -4,6 +4,11 @@ Installation ************ + +======================================= +Installation on Linux, Unix and similar +======================================= + 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 can not find it, you are probably working bleeding edge in the repository. Run the diff --git a/pcsc-relay/doc/download.txt b/pcsc-relay/doc/download.txt index 8f7aa7c..7b1d4ee 100644 --- a/pcsc-relay/doc/download.txt +++ b/pcsc-relay/doc/download.txt @@ -4,7 +4,9 @@ Download ******** -You can find the latest release of PC/SC Relay on `Sourceforge +You can find the latest release of PC/SC Relay on `Github +`_. Older releases are +still available on `Sourceforge `_. Alternatively, you can clone our git repository:: diff --git a/virtualsmartcard/doc/README.txt b/virtualsmartcard/doc/README.txt index 1727359..fd4e5fc 100644 --- a/virtualsmartcard/doc/README.txt +++ b/virtualsmartcard/doc/README.txt @@ -95,6 +95,16 @@ The file :file:`utils.py` was taken from Henryk Plötz's cyberflex-shell_. ; \end{pgfonlayer} +Depending on your usage of the |vpicc| you may need to install the following: + +- Python_ +- pyscard_ +- PyCrypto_ +- PBKDF2_ +- PIP_ +- readline_ or PyReadline_ +- OpenPACE_ (nPA emulation) + .. include:: download.txt @@ -103,16 +113,6 @@ The file :file:`utils.py` was taken from Henryk Plötz's cyberflex-shell_. .. include:: autotools.txt -Depending on your usage of the |vpicc| you might or might not need -the following: - -- Python_ -- pyscard_ -- PyCrypto_ -- PBKDF2_ -- PIP_ -- OpenPACE_ (nPA emulation) - ================================================================================ Building and installing |vpcd| on Windows @@ -125,7 +125,8 @@ Building and installing |vpcd| on Windows For the Windows integration we extended `Fabio Ottavi's UMDF Driver for a Virtual Smart Card Reader`_ with a |vpcd| interface. To build |vpcd| for -Windows we use `Windows Driver Kit 8.1 and Visual Studio 2013`_: +Windows we use `Windows Driver Kit 8.1 and Visual Studio 2013`_. If you choose +to download the `Windows binaries`_, you may directly jump to step 3. 1. In Visual Studio select :menuselection:`File --> Open --> Convert @@ -221,8 +222,13 @@ Currently it is not possible to configure the Windows driver to connect to an Running |vpicc| ================================================================================ -The command :command:`vicc --help` gives an overview about the command line -options of |vpicc|. +The compiled `Windows binaries`_ of |vpicc| include OpenPACE. The other +dependencies listed above need to be installed seperately. You can start the +|vpicc| via :command:`python.exe vicc.py`. On all other systems an executable +script :command:`vicc` is installed using the autotools. + +The |vpicc| option :option:`--help` gives an overview about the command line +switches: .. program-output:: vicc --help @@ -233,13 +239,6 @@ options of |vpicc|. :command:`vpcd-config` also prints a QR code for configuration of the :ref:`remote-reader`. -On Windows you can start |vpicc| with :command:`python.exe src/vpicc/vicc.in` -or :command:`python.exe vicc`. Note emulating the German ID card -(:option:`--type nPA`) when running |vpicc| on Windows is currently not -supported, because OpenPACE's Python bindings are untested for Windows. -However, it is possible to connect an emulated ID card running on Linux to a -|vpcd| running on Windows. - When |vpcd| and |vpicc| are connected you should be able to access the card through the PC/SC API. You can use the :command:`opensc-explorer` or :command:`pcsc_scan` for testing. In Virtual Smart Card's root directory we also @@ -265,8 +264,11 @@ Notes and References .. _pyscard: http://pyscard.sourceforge.net/ .. _PyCrypto: http://pycrypto.org/ .. _PBKDF2: https://www.dlitz.net/software/python-pbkdf2/ +.. _readline: https://docs.python.org/3.3/library/readline.html +.. _PyReadline: https://pypi.python.org/pypi/pyreadline .. _PIP: http://www.pythonware.com/products/pil/ .. _OpenPACE: https://github.com/frankmorgner/openpace .. _`Fabio Ottavi's UMDF Driver for a Virtual Smart Card Reader`: http://www.codeproject.com/Articles/134010/An-UMDF-Driver-for-a-Virtual-Smart-Card-Reader .. _`Windows Driver Kit 8.1 and Visual Studio 2013`: http://msdn.microsoft.com/en-us/windows/hardware/hh852365.aspx .. _`Microsoft's Kernel-Mode Code Signing Walkthrough`: http://msdn.microsoft.com/en-us/library/windows/hardware/dn653569%28v=vs.85%29.aspx +.. _`Windows binaries`: https://github.com/frankmorgner/vsmartcard/releases/download/virtualsmartcard-0.7/virtualsmartcard-0.7_win32.zip diff --git a/virtualsmartcard/doc/README.txt.in b/virtualsmartcard/doc/README.txt.in index a059721..b61b4f0 100644 --- a/virtualsmartcard/doc/README.txt.in +++ b/virtualsmartcard/doc/README.txt.in @@ -95,16 +95,7 @@ The file :file:`utils.py` was taken from Henryk Plötz's cyberflex-shell_. ; \end{pgfonlayer} - -.. include:: download.txt - - -.. _vicc_install: - -.. include:: autotools.txt - -Depending on your usage of the |vpicc| you might or might not need -the following: +Depending on your usage of the |vpicc| you may need to install the following: - Python_ - pyscard_ @@ -115,6 +106,14 @@ the following: - OpenPACE_ (nPA emulation) +.. include:: download.txt + + +.. _vicc_install: + +.. include:: autotools.txt + + ================================================================================ Building and installing |vpcd| on Windows ================================================================================ @@ -126,7 +125,8 @@ Building and installing |vpcd| on Windows For the Windows integration we extended `Fabio Ottavi's UMDF Driver for a Virtual Smart Card Reader`_ with a |vpcd| interface. To build |vpcd| for -Windows we use `Windows Driver Kit 8.1 and Visual Studio 2013`_: +Windows we use `Windows Driver Kit 8.1 and Visual Studio 2013`_. If you choose +to download the `Windows binaries`_, you may directly jump to step 3. 1. In Visual Studio select :menuselection:`File --> Open --> Convert @@ -222,8 +222,13 @@ Currently it is not possible to configure the Windows driver to connect to an Running |vpicc| ================================================================================ -The command :command:`vicc --help` gives an overview about the command line -options of |vpicc|. +The compiled `Windows binaries`_ of |vpicc| include OpenPACE. The other +dependencies listed above need to be installed seperately. You can start the +|vpicc| via :command:`python.exe vicc.py`. On all other systems an executable +script :command:`vicc` is installed using the autotools. + +The |vpicc| option :option:`--help` gives an overview about the command line +switches: .. program-output:: vicc --help @@ -234,13 +239,6 @@ options of |vpicc|. :command:`vpcd-config` also prints a QR code for configuration of the :ref:`remote-reader`. -On Windows you can start |vpicc| with :command:`python.exe src/vpicc/vicc.in` -or :command:`python.exe vicc`. Note emulating the German ID card -(:option:`--type nPA`) when running |vpicc| on Windows is currently not -supported, because OpenPACE's Python bindings are untested for Windows. -However, it is possible to connect an emulated ID card running on Linux to a -|vpcd| running on Windows. - When |vpcd| and |vpicc| are connected you should be able to access the card through the PC/SC API. You can use the :command:`opensc-explorer` or :command:`pcsc_scan` for testing. In @PACKAGE_NAME@'s root directory we also @@ -273,3 +271,4 @@ Notes and References .. _`Fabio Ottavi's UMDF Driver for a Virtual Smart Card Reader`: http://www.codeproject.com/Articles/134010/An-UMDF-Driver-for-a-Virtual-Smart-Card-Reader .. _`Windows Driver Kit 8.1 and Visual Studio 2013`: http://msdn.microsoft.com/en-us/windows/hardware/hh852365.aspx .. _`Microsoft's Kernel-Mode Code Signing Walkthrough`: http://msdn.microsoft.com/en-us/library/windows/hardware/dn653569%28v=vs.85%29.aspx +.. _`Windows binaries`: https://github.com/frankmorgner/vsmartcard/releases/download/virtualsmartcard-0.7/virtualsmartcard-0.7_win32.zip diff --git a/virtualsmartcard/doc/autotools.txt b/virtualsmartcard/doc/autotools.txt index cc278d4..9fed797 100644 --- a/virtualsmartcard/doc/autotools.txt +++ b/virtualsmartcard/doc/autotools.txt @@ -4,6 +4,11 @@ Installation ************ + +======================================= +Installation on Linux, Unix and similar +======================================= + 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 can not find it, you are probably working bleeding edge in the repository. Run the diff --git a/virtualsmartcard/doc/download.txt b/virtualsmartcard/doc/download.txt index 1381f54..250412e 100644 --- a/virtualsmartcard/doc/download.txt +++ b/virtualsmartcard/doc/download.txt @@ -4,7 +4,9 @@ Download ******** -You can find the latest release of Virtual Smart Card on `Sourceforge +You can find the latest release of Virtual Smart Card on `Github +`_. Older releases are +still available on `Sourceforge `_. Alternatively, you can clone our git repository::