regenerated documentation
This commit is contained in:
Frank Morgner
@@ -26,7 +26,6 @@ device instead of the phone.
|
||||
With the built-in Java Card runtime of jCardSim_ the app includes the following
|
||||
Applets:
|
||||
|
||||
- `Hello World Applet`_ (application identifier ``F000000001``)
|
||||
- `OpenPGP Applet`_ (application identifier ``D2760001240102000000000000010000``)
|
||||
- `OATH Applet`_ (application identifier ``A000000527210101``)
|
||||
- `ISO Applet`_ (application identifier ``F276A288BCFBA69D34F31001``)
|
||||
|
||||
@@ -56,6 +56,12 @@ In the next dialog choose :file:`Tizen/TCardEmulator`. To be able to build and
|
||||
install the Tizen service on the smartwatch, you need to `install the
|
||||
appropriate SDK extensions and register as app developer`_.
|
||||
|
||||
More usefull ressources:
|
||||
|
||||
- `Tizen Developers: Near Field Communication (NFC)`_
|
||||
- `Programming Guide: Accessory`_
|
||||
- `Guidelines on Connecting a Gear S2 Device Using Wi-Fi`_
|
||||
|
||||
|
||||
.. include:: questions.txt
|
||||
|
||||
@@ -68,3 +74,6 @@ Notes and References
|
||||
|
||||
.. _Tizen SDK: https://developer.tizen.org/development/tools/download
|
||||
.. _`install the appropriate SDK extensions and register as app developer`: https://developer.tizen.org/community/tip-tech/tizen-sdk-install-guide-certificate-extensions-included
|
||||
.. _`Tizen Developers: Near Field Communication (NFC)`: https://developer.tizen.org/development/guides/native-application/connectivity-and-wireless/nfc
|
||||
.. _`Programming Guide: Accessory`: http://developer.samsung.com/html/techdoc/ProgrammingGuide_Accessory.pdf
|
||||
.. _Guidelines on Connecting a Gear S2 Device Using Wi-Fi: http://developer.samsung.com/html/techdoc/Guidelines_on_Connecting_GearS2_device_using_WiFi_151222.pdf
|
||||
|
||||
@@ -1,12 +0,0 @@
|
||||
.. meta::
|
||||
:http-equiv=refresh: 0;URL='https://github.com/frankmorgner/OpenSC'
|
||||
|
||||
######################
|
||||
nPA Smart Card Library
|
||||
######################
|
||||
|
||||
Access the German electronic identity card (neuer Personalausweis/nPA).
|
||||
|
||||
The functionality of nPA Smart Card Library has been integrated into
|
||||
OpenSC. Developement and Support will continue at our new home
|
||||
https://github.com/frankmorgner/OpenSC.
|
||||
@@ -169,7 +169,6 @@ to completely emulate an ISO/IEC 14443 smart card.
|
||||
PC/SC Relay has the following dependencies:
|
||||
|
||||
- PC/SC middleware
|
||||
- libnfc_
|
||||
|
||||
|
||||
.. include:: relay-note.txt
|
||||
@@ -190,7 +189,7 @@ installation of libnfc::
|
||||
|
||||
PREFIX=/tmp/install
|
||||
LIBNFC=libnfc
|
||||
git clone https://code.google.com/p/libnfc $LIBNFC
|
||||
git clone https://github.com/nfc-tools/libnfc $LIBNFC
|
||||
cd $LIBNFC
|
||||
autoreconf -i
|
||||
# See `./configure --help` for enabling support of additional hardware
|
||||
@@ -291,6 +290,6 @@ Notes and References
|
||||
.. target-notes::
|
||||
|
||||
.. _`Hardware supported by libnfc`: http://nfc-tools.org/index.php?title=Devices_compatibility_matrix
|
||||
.. _libnfc: http://www.libnfc.org/
|
||||
.. _libnfc: https://github.com/nfc-tools/libnfc
|
||||
.. _OpenPICC: http://www.openpcd.org/OpenPICC
|
||||
.. _PCSC-lite: https://pcsclite.apdu.fr/
|
||||
|
||||
@@ -102,10 +102,10 @@ responses via NFC to a contact-less smart card that signs the mail.
|
||||
Depending on your usage of the |vpicc| you may need to install the following:
|
||||
|
||||
- Python_
|
||||
- pyscard_ (relaying a local smart card with :option:`--type=relay`)
|
||||
- pyscard_ (relaying a local smart card with `--type=relay`)
|
||||
- PyCrypto_, PBKDF2_, PIL_, readline_ or PyReadline_ (emulation of electronic
|
||||
passport with :option:`--type=ePass`)
|
||||
- OpenPACE_ (emulation of German identity card with :option:`--type=nPA`)
|
||||
passport with `--type=ePass`)
|
||||
- OpenPACE_ (emulation of German identity card with `--type=nPA`)
|
||||
- libqrencode_ (to print a QR code on the command line for `vpcd-config`; an
|
||||
URL will be printed if libqrencode is not available)
|
||||
|
||||
@@ -129,9 +129,9 @@ Mac OS X 10.10 (and later) ships with a proprietary implementation of the PC/SC
|
||||
layer instead of with PCSC-Lite. As far as we know, this means that smart card
|
||||
readers must be USB devices instead of directly allowing a more generic type of
|
||||
reader. To make |vpcd| work we simply configure it to pretend being a USB smart
|
||||
card reader with an :file:`Ìnfo.plist`::
|
||||
card reader with an :file:`Info.plist`::
|
||||
|
||||
./configure --prefix=/ --enable-infoplist
|
||||
./configure --enable-infoplist
|
||||
make
|
||||
make install
|
||||
|
||||
@@ -209,7 +209,7 @@ connections. The port to open should be specified in ``CHANNELID`` and
|
||||
|
||||
If the first part of the ``DEVICENAME`` is different from ``/dev/null``, |vpcd|
|
||||
will use this string as a hostname for connecting to a waiting |vpicc|. |vpicc|
|
||||
needs to be started with :option:`--reversed` in this case.
|
||||
needs to be started with `--reversed` in this case.
|
||||
|
||||
================================================================================
|
||||
Configuring |vpcd| on Mac OS X
|
||||
@@ -229,7 +229,7 @@ as USB device:
|
||||
|
||||
system_profiler SPUSBDataType
|
||||
|
||||
3. Change :file:`/usr/libexec/SmartCardServices/drivers/ifd-vpcd.bundle/Info.plist`
|
||||
3. Change :file:`/usr/local/libexec/SmartCardServices/drivers/ifd-vpcd.bundle/Info.plist`
|
||||
to match your product and vendor ID:
|
||||
|
||||
.. literalinclude:: Info.plist
|
||||
@@ -240,11 +240,20 @@ Note that ``ifdFriendlyName`` can be used in the same way as ``DEVICENAME``
|
||||
|
||||
4. Restart the PC/SC service::
|
||||
|
||||
sudo killall -SIGKILL -m .*com.apple.ifdreader
|
||||
sudo killall -SIGKILL -m '.*com.apple.ifdreader'
|
||||
|
||||
Now, every time you plug in your USB device |vpcd| will be started. It will be
|
||||
stopped when you unplug the device.
|
||||
|
||||
To verify the installation, execute::
|
||||
|
||||
system_profiler SPSmartCardsDataType
|
||||
|
||||
In case of a problem, inspect the logs::
|
||||
|
||||
log show --predicate '(subsystem == "com.apple.CryptoTokenKit")' --info --debug
|
||||
|
||||
|
||||
================================================================================
|
||||
Configuring |vpcd| on Windows
|
||||
================================================================================
|
||||
@@ -262,7 +271,7 @@ to open should be specified in ``TCP_PORT``:
|
||||
:emphasize-lines: 8
|
||||
|
||||
Currently it is not possible to configure the Windows driver to connect to an
|
||||
|vpicc| running with :option:`--reversed`.
|
||||
|vpicc| running with `--reversed`.
|
||||
|
||||
================================================================================
|
||||
Running |vpicc|
|
||||
@@ -273,7 +282,7 @@ 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
|
||||
The |vpicc| option `--help` gives an overview about the command line
|
||||
switches:
|
||||
|
||||
.. program-output:: vicc --help
|
||||
@@ -281,7 +290,7 @@ switches:
|
||||
.. versionadded:: 0.7
|
||||
We implemented :command:`vpcd-config` which tries to guess the local IP
|
||||
address and outputs |vpcd|'s configuration. |vpicc|'s options should be
|
||||
chosen accordingly (:option:`--hostname` and :option:`--port`)
|
||||
chosen accordingly (`--hostname` and `--port`)
|
||||
:command:`vpcd-config` also prints a QR code for configuration of the
|
||||
:ref:`remote-reader`.
|
||||
|
||||
|
||||
@@ -33,15 +33,6 @@ The communication is initiated by |vpcd|. First the length of the data (in
|
||||
network byte order, i.e. big endian) is sent followed by the data itself.
|
||||
|
||||
|
||||
===================================
|
||||
Documentation to Virtual Smart Card
|
||||
===================================
|
||||
|
||||
.. toctree::
|
||||
|
||||
api/virtualsmartcard
|
||||
|
||||
|
||||
========
|
||||
Examples
|
||||
========
|
||||
@@ -56,8 +47,7 @@ includes all standard commands for file management and secure messaging.
|
||||
Let's assume we want to create a cryptoflex card, that acts mostly according to
|
||||
ISO 7816. In this example we only want to add little things that differ from
|
||||
ISO 7816. But as for most complex software you need to know where you need to
|
||||
hook into. Here we only want to give an overview to the design, the complete
|
||||
details can be found in section `Documentation to Virtual Smart Card`_.
|
||||
hook into. Here we only want to give an overview to the design.
|
||||
|
||||
Back to the cryptoflex example.
|
||||
:class:`~virtualsmartcard.VirtualSmartcard.VirtualICC` provides the connection
|
||||
|
||||
@@ -0,0 +1,10 @@
|
||||
RelayMiddleman Module
|
||||
=====================
|
||||
|
||||
.. inheritance-diagram:: virtualsmartcard.cards.RelayMiddleman
|
||||
.. automodule:: virtualsmartcard.cards.RelayMiddleman
|
||||
:members:
|
||||
:undoc-members:
|
||||
:inherited-members:
|
||||
:show-inheritance:
|
||||
:private-members:
|
||||
@@ -5,6 +5,7 @@ cards Package
|
||||
|
||||
virtualsmartcard.cards.HandlerTest
|
||||
virtualsmartcard.cards.Relay
|
||||
virtualsmartcard.cards.RelayMiddleman
|
||||
virtualsmartcard.cards.cryptoflex
|
||||
virtualsmartcard.cards.ePass
|
||||
virtualsmartcard.cards.nPA
|
||||
|
||||
Reference in New Issue
Block a user