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

added more markup

Browse Source 
git-svn-id: https://vsmartcard.svn.sourceforge.net/svnroot/vsmartcard@590 96b47cad-a561-4643-ad3b-153ac7d7599c
This commit is contained in:
frankmorgner
2011-10-28 08:32:25 +00:00
parent 6fb625d089
commit f302a271f8
4 changed files with 35 additions and 30 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
ccid/doc/README.rst
View File

@@ -33,7 +33,7 @@ Installation
=============
ccid uses the GNU Build System to compile and install. If you are unfamiliar
with it, please have a look at the file ``INSTALL``. If you have a look around
with it, please have a look at the file :file:`INSTALL`. If you have a look around
and can not find it, you are probably working bleeding edge in the repository.
Run the following command in the npa directory to get the missing standard
auxiliary files::
@@ -44,7 +44,7 @@ ccid as the following dependencies:
- Linux Kernel with GadgetFS_
- OpenSC_
- libnpa
- :ref:`npa` (only if support for PACE is enabled)
-----------------
@@ -52,16 +52,16 @@ Hints on GadgetFS
-----------------
To create an USB Gadget in both USB host and USB client mode, you need to load
the kernel module ``gadgetfs``. A guide focused on Debian based systems to run
the kernel module :program:`gadgetfs`. A guide focused on Debian based systems to run
and compile gadgetfs, you can find `here
<http://wiki.openmoko.org/wiki/Building_Gadget_USB_Module>`_.
On OpenMoko it is likely that you need to `patch your kernel
<http://docs.openmoko.org/trac/ticket/2206>`_. If you also want to switch
multiple times between ``gadgetfs`` and ``g_ether``, `another patch is needed
multiple times between :program:`gadgetfs` and :program:`g_ether`, `another patch is needed
<http://docs.openmoko.org/trac/ticket/2240)>`_.
If you are using a more recent version of ``dummy_hcd`` and get an error
If you are using a more recent version of :program:`dummy_hcd` and get an error
loading the module, you maybe want to check out `this patch
<http://comments.gmane.org/gmane.linux.usb.general/47440>`_.
@@ -85,7 +85,7 @@ an example of how to get the standard installation of OpenSC_::
make
make install
Now ``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 ccid-emulator to use it::
./configure OPENSC_LIBS="-L$PREFIX/lib -lopensc"

14
npa/doc/README.rst
View File

@@ -4,6 +4,8 @@
.. _OpenPACE: http://sourceforge.net/projects/openpace/
.. _npa:
***
npa
***
@@ -34,7 +36,7 @@ Installation
============
npa uses the GNU Build System to compile and install. If you are unfamiliar
with it, please have a look at the file ``INSTALL``. If you have a look around
with it, please have a look at file:`INSTALL`. If you have a look around
and can not find it, you are probably working bleeding edge in the repository.
Run the following command in the npa directory to get the missing standard
auxiliary files::
@@ -65,8 +67,8 @@ an example of how to get the standard installation of OpenSSL with OpenPACE_::
make
make install
Building npa with OpenPACE_ is done best using ``pkg-config``. The file
``libcrypto.pc`` should be located in ``$INSTALL/lib/pkgconfig``. Here is how
Building npa with OpenPACE_ is done best using :command:`pkg-config`. The file
:file:`libcrypto.pc` should be located in ``$INSTALL/lib/pkgconfig``. Here is how
to configure npa to use it::
./configure PKG_CONFIG_PATH=$PREFIX/lib/pkgconfig
@@ -79,7 +81,7 @@ Hints on OpenSC
libnpa links against libopensc, which is discouraged and hindered since OpenSC
version >= 0.12. (We really need to get rid of this dependency or integrate
better into the OpenSC-framework.) You need the OpenSC components to be
installed (especially ``libopensc.so``). Here is an example of how to get the
installed (especially :file:`libopensc.so`). Here is an example of how to get the
standard installation of OpenSC_::
PREFIX=/tmp/install
@@ -92,7 +94,7 @@ standard installation of OpenSC_::
make
make install
Now ``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 npa to use it::
./configure OPENSC_LIBS="-L$PREFIX/lib -lopensc"
@@ -118,7 +120,7 @@ Linking against libnpa
----------------------
Following the section `Installation`_ above, you have installed OpenSC_,
OpenPACE_ and npa to ``/tmp/install``. To compile a program using libnpa you
OpenPACE_ and npa to :file:`/tmp/install`. To compile a program using libnpa you
need to get the header files from OpenSC_ as well.
Here is how
to compile an external program with these libraries::

6
pcsc-relay/doc/README.rst
View File

@@ -27,7 +27,7 @@ Installation
============
pcsc-relay uses the GNU Build System to compile and install. If you are
unfamiliar with it, please have a look at the file ``INSTALL``. If you have a
unfamiliar with it, please have a look at the file :file:`INSTALL`. If you have a
look around and can not find it, you are probably working bleeding edge in the
repository. Run the following command in the pcsc-relay directory to get the
missing standard auxiliary files::
@@ -56,8 +56,8 @@ installation of the latter::
make
make install
Building pcsc-relay with libnfc_ is done best using ``pkg-config``. The file
``libnfc.pc`` should be located in ``$INSTALL/lib/pkgconfig``. Here is how to
Building pcsc-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 pcsc-relay to use it::
./configure PKG_CONFIG_PATH=$PREFIX/lib/pkgconfig

33
virtualsmartcard/doc/README.rst
View File

@@ -9,6 +9,9 @@
.. _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)`
******************
Virtual Smart Card
@@ -21,18 +24,18 @@ Virtual Smart Card
GPL version 3
:Tested Platforms:
- Linux (Debian, Ubuntu, OpenMoko)
- Windows (only virtual smart card, not the virtual reader)
- Windows (only |vpicc|, not |vpcd|)
Welcome to virtualsmartcard. The purpose of virtualsmartcard is to emulate a
smart card and make it accessible through PCSC. Currently the virtual smart
card supports almost all commands of ISO-7816 including secure messaging.
Besides a plain ISO-7816 smart card it is also possible to emulate a German
ePass (only basic access control) and a rudimentary Cryptoflex smart card. The
virtual smart card (vpicc) can be accessed through the virtual smart card
reader (vpcd) which is a driver for ``pcscd`` of PCSC-Lite_.
|vpicc| can be accessed through the |vpcd| which is a driver for
:command:`pcscd` of PCSC-Lite_.
By default the vicc communicates with the vpcd through a socket on localhost
port 35963. The file ``utils.py`` was taken from Henryk Plötz's
port 35963. The file :file:`utils.py` was taken from Henryk Plötz's
cyberflex-shell_.
@@ -41,14 +44,14 @@ Installation
------------
virtualsmartcard uses the GNU Build System to compile and install. If you are
unfamiliar with it, please have a look at the file ``INSTALL``. If you have a
unfamiliar with it, please have a look at the file :file:`INSTALL`. If you have a
look around and can not find it, you are probably working bleeding edge in the
repository. Run the following command in the virtualsmartcard directory to get
the missing standard auxiliary files::
autoreconf -i
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:
- Python_
@@ -57,7 +60,7 @@ the following:
- PBKDF2_
- PIP_
The vpcd has the following dependencies:
The |vpcd| has the following dependencies:
- PCSC-Lite_
@@ -66,16 +69,16 @@ The vpcd has the following dependencies:
Running virtualsmartcard
------------------------
First you need to make sure that pcscd loads the vpcd. You might need to run
``update-reader.conf`` to update pcscd's configuration file. Then ``pcscd -f
-d`` should say something like ``Attempting startup of Virtual PCD``
First you need to make sure that pcscd loads the |vpcd|. You might need to run
:command:`update-reader.conf` to update pcscd's configuration file. Then
:command:`pcscd -f -d` should say something like ``Attempting startup of
Virtual PCD``
Now you can run ``vicc`` which connects to the virtual reader. The
command ``vicc --help`` gives an overview about the command line
options.
Now you can run :command:`vicc` which connects to the |vpcd|. The command
:command:`vicc --help` gives an overview about the command line options.
You should now be able to access the vpicc through the system's
PC/SC API via vpcd/pcscd. You can use the opensc-explorer or pcsc_scan to test
You should now be able to access the |vpicc| through the system's
PC/SC API via |vpcd|/pcscd. You can use the opensc-explorer or pcsc_scan to test
that.