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

updated documentation

Browse Source
This commit is contained in:
Frank Morgner
2014-11-20 21:25:31 +01:00
parent e3d703161c
commit b27126e450
16 changed files with 102 additions and 71 deletions
Download Patch File Download Diff File Expand all files Collapse all files

42
virtualsmartcard/doc/README.txt
View File

@@ -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

39
virtualsmartcard/doc/README.txt.in
View File

@@ -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

5
virtualsmartcard/doc/autotools.txt
View File

@@ -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

4
virtualsmartcard/doc/download.txt
View File

@@ -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
<https://github.com/frankmorgner/vsmartcard/releases>`_. Older releases are
still available on `Sourceforge
<http://sourceforge.net/projects/vsmartcard/files>`_.
Alternatively, you can clone our git repository::