updated documentation

virtualsmartcard/doc/Makefile.am

@@ -17,13 +17,14 @@ do_subst = $(SED) \
 	   -e 's,[@]abs_top_srcdir[@],$(abs_top_srcdir),g' \
 	   -e 's,[@]top_srcdir[@],$(top_srcdir),g'
 
-EXTRA_DIST = README.rst.in README.rst autotools.rst.in questions.rst.in autotools.rst questions.rst
+EXTRA_DIST = README.rst.in README.rst autotools.rst.in questions.rst.in autotools.rst questions.rst download.rst.in download.rst
 
 dist_noinst_SCRIPTS = generate_modules.py
 
 doc: $(top_srcdir)/src/vpicc/virtualsmartcard/*.py $(top_srcdir)/src/vpicc/virtualsmartcard/cards/*.py generate_modules.py *.in
 	$(do_subst) < autotools.rst.in > autotools.rst
 	$(do_subst) < questions.rst.in > questions.rst
+	$(do_subst) < download.rst.in  > download.rst
 	$(do_subst) < README.rst.in > README.rst
 	./generate_modules.py $(top_srcdir)/src/vpicc --dest-dir=api --suffix=rst --no-toc -1 -f
 	touch doc

virtualsmartcard/doc/README.rst

@@ -13,6 +13,9 @@
 .. |vpcd| replace:: :abbr:`vpcd (virtual smart card reader)`
 .. |EAC| replace:: :abbr:`EAC (Extended Access Control)`
 .. |PACE| replace:: :abbr:`PACE (Password Authenticated Connection Establishment)`
+.. |TA| replace:: :abbr:`TA (Terminal Authenticatation)`
+.. |CA| replace:: :abbr:`CA (Chip Authentication)`
+.. |BAC| replace:: :abbr:`BAC (Basic Access Control)`
 
 .. _vicc:
 
@@ -35,14 +38,14 @@ Virtual Smart Card emulates a smart card and makes it accessible through PC/SC.
 Currently the Virtual Smart Card supports the following types of smart cards:
 
 - Generic ISO-7816 smart card including secure messaging
-- German electronic identity card (nPA) with |EAC| including |PACE|
-- German electronic passport (ePass) with basic access control
+- German electronic identity card (nPA) with complete support for |EAC| (|PACE|, |TA|, |CA|)
+- German electronic passport (ePass) with complete support for |BAC|
 - Cryptoflex smart card (incomplete)
       
 The |vpcd| is a smart card driver for PCSC-Lite_. It allows
 smart card applications to access the |vpicc| through the PC/SC API.  By
 default |vpicc| communicates with |vpcd| through a socket on localhost port
-35963. But the |vpicc| does not need to run on the same machine as the |vpcd|,
+``35963``. But the |vpicc| does not need to run on the same machine as the |vpcd|,
 they can connect over the internet for example.
 
 Although the Virtual Smart Card is a software emulator, you can use
@@ -52,6 +55,9 @@ reader.
 The file :file:`utils.py` was taken from Henryk Plötz's cyberflex-shell_.
 
 
+.. include:: download.rst
+
+
 .. include:: autotools.rst
 
 Depending on your usage of the |vpicc| you might or might not need

virtualsmartcard/doc/README.rst.in

@@ -13,6 +13,9 @@
 .. |vpcd| replace:: :abbr:`vpcd (virtual smart card reader)`
 .. |EAC| replace:: :abbr:`EAC (Extended Access Control)`
 .. |PACE| replace:: :abbr:`PACE (Password Authenticated Connection Establishment)`
+.. |TA| replace:: :abbr:`TA (Terminal Authenticatation)`
+.. |CA| replace:: :abbr:`CA (Chip Authentication)`
+.. |BAC| replace:: :abbr:`BAC (Basic Access Control)`
 
 .. _vicc:
 
@@ -35,8 +38,8 @@
 Currently the @PACKAGE_NAME@ supports the following types of smart cards:
 
 - Generic ISO-7816 smart card including secure messaging
-- German electronic identity card (nPA) with |EAC| including |PACE|
-- German electronic passport (ePass) with basic access control
+- German electronic identity card (nPA) with complete support for |EAC| (|PACE|, |TA|, |CA|)
+- German electronic passport (ePass) with complete support for |BAC|
 - Cryptoflex smart card (incomplete)
       
 The |vpcd| is a smart card driver for PCSC-Lite_. It allows
@@ -52,6 +55,9 @@ reader.
 The file :file:`utils.py` was taken from Henryk Plötz's cyberflex-shell_.
 
 
+.. include:: download.rst
+
+
 .. include:: autotools.rst
 
 Depending on your usage of the |vpicc| you might or might not need

virtualsmartcard/doc/download.rst

@@ -0,0 +1,12 @@
+.. highlight:: sh
+
+===============================================================================
+Download
+===============================================================================
+
+You can find the latest release of Virtual Smart Card `here
+<http://sourceforge.net/projects/vsmartcard/files>`_.
+
+Alternatively, you can clone our git repository::
+
+    git clone git://vsmartcard.git.sourceforge.net/gitroot/vsmartcard/vsmartcard

virtualsmartcard/doc/download.rst.in

@@ -0,0 +1 @@
+../../doc/download.rst.in

virtualsmartcard/src/vpicc/Makefile.am

@@ -35,7 +35,7 @@ $(builddir)/vicc: vicc.in Makefile
 	$(do_subst) < $(srcdir)/vicc.in > $(builddir)/vicc
 	chmod +x $(builddir)/vicc
 
-$(builddir)/vicc.1:
+$(builddir)/vicc.1: vicc.in
 	$(HELP2MAN) \
 		--no-discard-stderr \
 		--output=$@ \

virtualsmartcard/src/vpicc/vicc.in

@@ -37,7 +37,7 @@ parser.add_argument("-t", "--type",
         action="store",
         choices=['iso7816', 'cryptoflex', 'ePass', 'nPA', 'relay'],
         default='iso7816',
-        help="Type of smart card to emulate (default: %(default)s)")
+        help="type of smart card to emulate (default: %(default)s)")
 parser.add_argument("-f", "--file",
         action="store",
         type=argparse.FileType('r'),
@@ -54,32 +54,33 @@ parser.add_argument("-P", "--port",
         help="port of the vpcd (default: %(default)s)")
 parser.add_argument('--version', action='version', version='%(prog)s @PACKAGE_VERSION@')
 
-relay = parser.add_argument_group('options for relaying a local smart card')
-relay.add_argument("-r", "--reader",
+relay = parser.add_argument_group('Relaying a local smart card (`--type=relay`)')
+relay.add_argument("--reader",
         action="store",
         type=int,
-        help="number of the reader which contains the smart card to be relayed.")
+        default=0,
+        help="number of the reader containing the card to be relayed (default: %(default)s)")
 
-npa = parser.add_argument_group('options for nPA emulation')
-npa.add_argument("-s", "--ef-cardsecurity",
+npa = parser.add_argument_group('Emulation of German identity card (`--type=nPA`)')
+npa.add_argument("--ef-cardaccess",
         action="store",
         type=argparse.FileType('rb'),
-        help="EF.CardSecurity with the signed CA public key.")
-npa.add_argument("-a", "--ef-cardaccess",
+        help="the card's EF.CardAccess (default: use file from first generation nPA)")
+npa.add_argument("--ef-cardsecurity",
         action="store",
         type=argparse.FileType('rb'),
-        help="EF.CardAccess with the EAC configuration.")
-npa.add_argument("-k", "--ca-key",
+        help="the card's EF.CardSecurity (default: use file from first generation nPA)")
+npa.add_argument("--cvca",
         action="store",
         type=argparse.FileType('rb'),
-        help="CA private key.")
-npa.add_argument("-C", "--cvca",
-        action="store",
-        type=argparse.FileType('rb'),
-        help="CVCA certificate")
-npa.add_argument("-d", "--disable-checks",
+        help="trust anchor for verifying certificates in TA (default: use libeac's trusted certificates)")
+npa.add_argument("--disable-ta-checks",
         action="store_true", default=False,
-        help="Disables checking validity period of TA certificates")
+        help="disable checking the validity period of CV certifcates (default: %(default)s)")
+npa.add_argument("--ca-key",
+        action="store",
+        type=argparse.FileType('rb'),
+        help="the chip's private key for CA (default: randomly generated, invalidates signature of EF.CardSecurity)")
 
 
 args = parser.parse_args()
@@ -106,5 +107,5 @@ if (args.cvca):
 vicc = VirtualICC(args.file, args.type,
         args.hostname, args.port, readernum=args.reader,
         ef_cardaccess=ef_cardaccess_data, ef_cardsecurity=ef_cardsecurity_data,
-        ca_key=ca_key_data, cvca=cvca, disable_checks=args.disable_checks)
+        ca_key=ca_key_data, cvca=cvca, disable_checks=args.disable_ta_checks)
 vicc.run()