rebuilt docs

vaginessa · Jan 4, 2017 · 564b939 · 564b939
1 parent c0d9799
commit 564b939
Show file tree

Hide file tree

Showing 36 changed files with 250 additions and 317 deletions.
diff --git a/docs/.buildinfo b/docs/.buildinfo
@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: db554396ed8a19f8462752faa93169b8
+config: 7394ee3fd05fb0ab6b49e356cffbaf4b
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/ACardEmulator/README.html b/docs/ACardEmulator/README.html
@@ -5,7 +5,7 @@
   <head>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
 
-    <title>Android Smart Card Emulator &mdash; vsmartcard 2016-10-12 documentation</title>
+    <title>Android Smart Card Emulator &mdash; vsmartcard 2017-01-05 documentation</title>
 
     <link rel="stylesheet" href="../_static/basic.css" type="text/css" />
     <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
@@ -15,7 +15,7 @@
     <script type="text/javascript">
       var DOCUMENTATION_OPTIONS = {
         URL_ROOT:    '../',
-        VERSION:     '2016-10-12',
+        VERSION:     '2017-01-05',
         COLLAPSE_INDEX: false,
         FILE_SUFFIX: '.html',
         HAS_SOURCE:  true
@@ -29,7 +29,7 @@
     <script type="text/javascript" src="../_static/bootstrap-3.3.4/js/bootstrap.min.js"></script>
     <script type="text/javascript" src="../_static/bootstrap-sphinx.js"></script>
     <link rel="shortcut icon" href="../_static/chip.ico"/>
-    <link rel="top" title="vsmartcard 2016-10-12 documentation" href="../index.html" />
+    <link rel="top" title="vsmartcard 2017-01-05 documentation" href="../index.html" />
     <link rel="next" title="PC/SC Relay" href="../pcsc-relay/README.html" />
     <link rel="prev" title="Remote Smart Card Reader" href="../remote-reader/README.html" />
 <meta charset='utf-8'>
@@ -321,7 +321,7 @@ <h2>Notes and References<a class="headerlink" href="#notes-and-references" title
 
     </p>
     <p>
-        &copy; Copyright 2009-2016 by Dominik Oepen and Frank Morgner.<br/>
+        &copy; Copyright 2009-2017 by Dominik Oepen and Frank Morgner.<br/>
     </p>
   </div>
 </footer>

diff --git a/docs/_sources/pcsc-relay/README.txt b/docs/_sources/pcsc-relay/README.txt
@@ -211,28 +211,28 @@ Hints on Android Smart Card Emulator
 
 The Android Smart Card Emulator is build around the host card emulation mode of
 Android 4.4 and later. This mode activates the app if the terminal issues a
-SELECT command with one of the app's application identifiers. The app registers
-for the following AIDs (:file:`ACardEmulator/app/src/main/res/xml/aid_list.xml`):
+SELECT command with one of the app's application identifiers. By default, the
+app only registers for the AIDs for which it has a built-in emulator (see
+:file:`ACardEmulator/app/src/main/res/xml/aid_list.xml`).
 
-.. literalinclude:: ../../ACardEmulator/app/src/main/res/xml/aid_list.xml
-    :language: xml
-    :emphasize-lines: 8,12,16,20
+If used together with PC/SC Relay, you need to change add AIDs to match the
+applications on the relayed card.  Otherwise the app will not be activated when
+it should relay command APDUs to PC/SC Relay.
 
-If used together with PC/SC Relay you need to change these application
-identifiers to match the emulated card. Otherwise the app will not be activated
-when it should relay command APDUs to PC/SC Relay.
+Modify the Smart Card Emulator settings to use ``Remote Virtual Smart Card`` as
+:guilabel:`Smart Card Emulator`. Now start :command:`pcsc-relay` by specifying
+usage of the vpcd emulator::
 
-And while you are already modifying the Android Smart Card Emulator you may also
-want to activate `useVPCD` and change `hostname` and `port` to configure the
-connection to PC/SC Relay
-(:file:`ACardEmulator/app/src/main/java/com/vsmartcard/acardemulator/SimulatorService.java`):
+    pcsc-relay --emulator vpcd
 
-.. literalinclude:: ../../ACardEmulator/app/src/main/java/com/vsmartcard/acardemulator/SimulatorService.java
-    :language: java
-    :lines: 47-52
-    :emphasize-lines: 3,5-6
+In the app, change the :guilabel:`VICC Hostname` and :guilabel:`VICC Port` to
+match the location where :command:`pcsc-relay` is waiting for an incoming
+connection. When the app receives a SELECT command to one of the configured
+AIDs, it will connect to :command:`pcsc-relay`, which will then relay the
+command for processing.
 
-Compiling and installing Android Smart Card Emulator is covered in its :ref:`acardemulator_install` section.
+Compiling and installing Android Smart Card Emulator is covered in its
+:ref:`acardemulator_install` section.
 
 
 =========================

diff --git a/docs/_sources/virtualsmartcard/README.txt b/docs/_sources/virtualsmartcard/README.txt
@@ -146,50 +146,37 @@ 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`_. If you choose
-to download the `Windows binaries`_, you may directly jump to step 3.
+Windows we use `Windows Driver Kit 10 and Visual Studio 2015`_. The vpcd
+installer requires the `WiX Toolset 3.10`_. If you choose
+to download the `Windows binaries`_, you may directly jump to step 4.
 
+1. Clone the git repository and make sure it is initialized with all
+   submodules::
 
-1. In Visual Studio select :menuselection:`File --> Open --> Convert
-   Sources/Dirs...` and choose the vpcd's :file:`sources` either in the
-   :file:`WinXP` [#footnote1]_ or :file:`Win7` folder.
+    git clone https://github.com/frankmorgner/vsmartcard.git
+    cd vsmartcard
+    git submodule update --init --recursive
 
-   When successfully imported, ensure with the configuration manager, that both
-   of the created projects are built for the same platform (x64 or Win32).
+2. In Visual Studio open |vpcd|'s solution
+   :file:`virtualsmartcard\\win32\\BixVReader.sln` and  ensure with the
+   configuration manager, that the project is built for your platform (i.e.
+   ``x64`` or ``x82``).
 
-2. If you can successfully :guilabel:`Build the solution`, you can find the
-   install package in :file:`BixVReader-package`. It contains `BixVReader.inf`
-   and the required libraries, especially `BixVReader.dll` and
-   `WudfUpdate_01009.dll` [#footnote2]_.
+3. If you can successfully :guilabel:`Build the solution`, you can find
+   the installer (:file:`BixVReaderInstaller.msi`) in
+   :file:`virtualsmartcard\\win32\\BixVReaderInstaller\\bin\\*Release`
 
-3. Copy :file:`win32\\BixVReader\\BixVReader.ini` into the :envvar:`%SystemRoot%`
-   directory.
-
-4. In a console with administrator rights go to :file:`BixVReader-package` and
-   install the driver::
-
-   "C:\Program Files\Windows Kits\8.1\Tools\x86\devcon.exe" install BixVReader.inf root\BixVirtualReader
-
-   You can adjust the path to ``devcon.exe`` with your version of the WDK and
-   your target architecture (e.g., use ``...\x64\devcon.exe`` for a 64 bit
-   driver). You can also download `DevCon's source code`_ and compile it
-   yourself.
-
-   For Win7 and older, code signing is optional and will yield a warning during
-   installation when missing. Simply click continue to install the driver anyway.
-
-   To activate the WDK test signing, use VS build-in Driver Signing settings.
-   Right click :guilabel:`BixVReader-package` :menuselection:`Properties -->
-   Driver Signing --> Sign Mode --> Test Sign`.  Import the WDKTestCert
-   certificate :file:`BixVReader-package.cer` into your windows keystore (e.g.
-   on local computer) and then install the driver. See
-   `Microsoft's Kernel-Mode Code Signing Walkthrough`_ for
-   details.
+4. To install |vpcd|, double click :file:`BixVReaderInstaller.msi`. Since we
+   are currently not signing the Installer, this will yield a warning about an
+   unverified driver software publisher on Windows 8 and later. Click
+   :guilabel:`Install this driver software anyway`.
 
 For debugging |vpcd| and building the driver with an older version of Visual
 Studio or WDK please see `Fabio Ottavi's UMDF Driver for a Virtual Smart Card
-Reader`_ for details. All of Fabio's card connectors (pipe reader/TCP/IP
-reader) are still active by default.
+Reader`_ for details.
+
+All of Fabio's card connectors are still available, but inactive by default
+(see `Configuring vpcd on Windows`_ below).
 
 
 ********************************************************************************
@@ -262,14 +249,14 @@ stopped when you unplug the device.
 Configuring |vpcd| on Windows
 ================================================================================
 
-The configuration file `BixVReader.ini` of |vpcd| is usually placed into
-:file:`C:\\Windows` (:envvar:`SystemRoot`). The user mode device driver
+The configuration file :file:`BixVReader.ini` of |vpcd| is installed to
+:file:`C:\\Windows` (:envvar:`%SystemRoot%`). The user mode device driver
 framework (:command:`WUDFHost.exe`) should read it automatically and load the
 |vpcd| on startup. The Windows Device Manager :command:`mmc devmgmt.msc` should
 list the :guilabel:`Bix Virtual Smart Card Reader`.
 
-|vpcd| opens a socket for |vpicc| and waits for incoming
-connections. The port to open should be specified in ``TCP_PORT``:
+|vpcd| opens a socket for |vpicc| and waits for incoming connections. The port
+to open should be specified in ``TCP_PORT``:
 
 .. literalinclude:: ../../virtualsmartcard/win32/BixVReader/BixVReader.ini
     :emphasize-lines: 8
@@ -314,9 +301,6 @@ Notes and References
 
 .. target-notes::
 
-.. [#footnote1] With VS 2013 and WDK 8.1 no Windows XP driver can be build. You need to use an older version of VS with WDK 7.1.0.
-.. [#footnote2] Note that WudfUpdate_01009.dll for 32 bit will be around 1795 KB and for 64 bit around 2102 KB big.
-
 .. _cyberflex-shell: https://github.com/henryk/cyberflex-shell
 .. _PCSC-lite: http://pcsclite.alioth.debian.org/
 .. _Python: http://www.python.org/
@@ -329,8 +313,7 @@ Notes and References
 .. _OpenPACE: https://github.com/frankmorgner/openpace
 .. _libqrencode: https://fukuchi.org/works/qrencode/
 .. _`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
-.. _`DevCon's source code`: https://github.com/Microsoft/Windows-driver-samples/tree/master/setup/devcon
-.. _`Microsoft's Kernel-Mode Code Signing Walkthrough`: http://msdn.microsoft.com/en-us/library/windows/hardware/dn653569%28v=vs.85%29.aspx
+.. _`Windows Driver Kit 10 and Visual Studio 2015`: https://msdn.microsoft.com/en-us/library/windows/hardware/ff557573
+.. _`WiX Toolset 3.10`: https://wixtoolset.org/releases/v3.10/stable
 .. _`Windows binaries`: https://github.com/frankmorgner/vsmartcard/releases/download/virtualsmartcard-0.7/virtualsmartcard-0.7_win32.zip
 .. _npa-tool: https://github.com/frankmorgner/OpenSC
diff --git a/docs/ccid/README.html b/docs/ccid/README.html
@@ -5,7 +5,7 @@
   <head>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
 
-    <title>USB CCID Emulator &mdash; vsmartcard 2016-10-12 documentation</title>
+    <title>USB CCID Emulator &mdash; vsmartcard 2017-01-05 documentation</title>
 
     <link rel="stylesheet" href="../_static/basic.css" type="text/css" />
     <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
@@ -15,7 +15,7 @@
     <script type="text/javascript">
       var DOCUMENTATION_OPTIONS = {
         URL_ROOT:    '../',
-        VERSION:     '2016-10-12',
+        VERSION:     '2017-01-05',
         COLLAPSE_INDEX: false,
         FILE_SUFFIX: '.html',
         HAS_SOURCE:  true
@@ -29,7 +29,7 @@
     <script type="text/javascript" src="../_static/bootstrap-3.3.4/js/bootstrap.min.js"></script>
     <script type="text/javascript" src="../_static/bootstrap-sphinx.js"></script>
     <link rel="shortcut icon" href="../_static/chip.ico"/>
-    <link rel="top" title="vsmartcard 2016-10-12 documentation" href="../index.html" />
+    <link rel="top" title="vsmartcard 2017-01-05 documentation" href="../index.html" />
     <link rel="next" title="Creating a Virtual Smart Card" href="../virtualsmartcard/api.html" />
     <link rel="prev" title="PC/SC Relay" href="../pcsc-relay/README.html" />
 <meta charset='utf-8'>
@@ -644,7 +644,7 @@ <h2>Notes and References<a class="headerlink" href="#notes-and-references" title
 
     </p>
     <p>
-        &copy; Copyright 2009-2016 by Dominik Oepen and Frank Morgner.<br/>
+        &copy; Copyright 2009-2017 by Dominik Oepen and Frank Morgner.<br/>
     </p>
   </div>
 </footer>

diff --git a/docs/index.html b/docs/index.html
@@ -5,7 +5,7 @@
   <head>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
 
-    <title>Welcome to the Virtual Smart Card Architecture documentation! &mdash; vsmartcard 2016-10-12 documentation</title>
+    <title>Welcome to the Virtual Smart Card Architecture documentation! &mdash; vsmartcard 2017-01-05 documentation</title>
 
     <link rel="stylesheet" href="_static/basic.css" type="text/css" />
     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
@@ -15,7 +15,7 @@
     <script type="text/javascript">
       var DOCUMENTATION_OPTIONS = {
         URL_ROOT:    './',
-        VERSION:     '2016-10-12',
+        VERSION:     '2017-01-05',
         COLLAPSE_INDEX: false,
         FILE_SUFFIX: '.html',
         HAS_SOURCE:  true
@@ -29,7 +29,7 @@
     <script type="text/javascript" src="_static/bootstrap-3.3.4/js/bootstrap.min.js"></script>
     <script type="text/javascript" src="_static/bootstrap-sphinx.js"></script>
     <link rel="shortcut icon" href="_static/chip.ico"/>
-    <link rel="top" title="vsmartcard 2016-10-12 documentation" href="#" />
+    <link rel="top" title="vsmartcard 2017-01-05 documentation" href="#" />
     <link rel="next" title="Virtual Smart Card" href="virtualsmartcard/README.html" />
 <meta charset='utf-8'>
 <meta http-equiv='X-UA-Compatible' content='IE=edge,chrome=1'>
@@ -271,7 +271,7 @@ <h2>References<a class="headerlink" href="#references" title="Permalink to this
 
     </p>
     <p>
-        &copy; Copyright 2009-2016 by Dominik Oepen and Frank Morgner.<br/>
+        &copy; Copyright 2009-2017 by Dominik Oepen and Frank Morgner.<br/>
     </p>
   </div>
 </footer>

diff --git a/docs/npa/README.html b/docs/npa/README.html
@@ -6,7 +6,7 @@
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
     <meta content="0;URL='https://github.com/frankmorgner/OpenSC'" http-equiv="refresh" />
 
-    <title>nPA Smart Card Library &mdash; vsmartcard 2016-10-12 documentation</title>
+    <title>nPA Smart Card Library &mdash; vsmartcard 2017-01-05 documentation</title>
 
     <link rel="stylesheet" href="../_static/basic.css" type="text/css" />
     <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
@@ -16,7 +16,7 @@
     <script type="text/javascript">
       var DOCUMENTATION_OPTIONS = {
         URL_ROOT:    '../',
-        VERSION:     '2016-10-12',
+        VERSION:     '2017-01-05',
         COLLAPSE_INDEX: false,
         FILE_SUFFIX: '.html',
         HAS_SOURCE:  true
@@ -30,7 +30,7 @@
     <script type="text/javascript" src="../_static/bootstrap-3.3.4/js/bootstrap.min.js"></script>
     <script type="text/javascript" src="../_static/bootstrap-sphinx.js"></script>
     <link rel="shortcut icon" href="../_static/chip.ico"/>
-    <link rel="top" title="vsmartcard 2016-10-12 documentation" href="../index.html" />
+    <link rel="top" title="vsmartcard 2017-01-05 documentation" href="../index.html" />
 <meta charset='utf-8'>
 <meta http-equiv='X-UA-Compatible' content='IE=edge,chrome=1'>
 <meta name='viewport' content='width=device-width, initial-scale=1.0, maximum-scale=1'>
@@ -158,7 +158,7 @@ <h1>nPA Smart Card Library<a class="headerlink" href="#npa-smart-card-library" t
 
     </p>
     <p>
-        &copy; Copyright 2009-2016 by Dominik Oepen and Frank Morgner.<br/>
+        &copy; Copyright 2009-2017 by Dominik Oepen and Frank Morgner.<br/>
     </p>
   </div>
 </footer>

diff --git a/docs/objects.inv b/docs/objects.inv