added missing files

git-svn-id: https://vsmartcard.svn.sourceforge.net/svnroot/vsmartcard@297 96b47cad-a561-4643-ad3b-153ac7d7599c

ccid/Doxyfile.in

@@ -0,0 +1,10 @@
+PROJECT_NAME           = @PACKAGE_NAME@
+PROJECT_NUMBER         = @PACKAGE_VERSION@
+OUTPUT_DIRECTORY       = @builddir@/doc
+STRIP_FROM_PATH        = @top_srcdir@/src
+INPUT                  = @top_srcdir@/src @top_srcdir@/README.dox
+FILE_PATTERNS          = *.c *.h
+RECURSIVE              = YES
+EXAMPLE_PATH           = @top_srcdir@/src
+GENERATE_HTML          = YES
+GENERATE_TAGFILE       = @builddir@/doc/$(PROJECT).tag

ccid/README.dox

@@ -0,0 +1,64 @@
+/** @mainpage
+
+Welcome to ccid.  The purpose of ccid is to forward a PCSC smartcard reader
+as a standard USB CCID reader. If the host system is in USB device mode, ccid
+forwards the local reader via USB to an other device. If in USB host mode,
+ccid virtually plugges in a USB CCID reader to the host system.
+
+ccid is implemented using GadgetFS. Some fragments of the source code is based
+on the GadgetFS example at http://www.linux-usb.org/gadget/ and on the source
+code of the OpenSC tools.
+
+pace-tool has support for Password Authenticated Connection Establishment
+(PACE) using OpenPACE (see http://sourceforge.net/projects/openpace/).
+pace-tool can be used for PIN management or to encrypt APDUs inside a secure
+messaging channel established with PACE. PACE is experimental and disabled by
+default.
+
+
+@section i INSTALLATION
+
+See file INSTALL.
+
+
+@subsection g 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 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 (see
+http://docs.openmoko.org/trac/ticket/2206). If you also want to switch multiple
+times between gadgetfs and g_ether an other patch is needed (see
+https://docs.openmoko.org/trac/ticket/2240).
+
+If you only use pace-tool for testing your card, you don't need gadgetfs.
+
+
+@subsection o HINTS ON OPENSC
+
+If ccid runs into a checking error, because the Le field of the APDU is 0 (as
+set for the General Authenticate APDU during PACE), you need to patch libopensc
+(see http://www.opensc-project.org/opensc/ticket/209)
+
+
+@section u USAGE
+
+When testing PACE with either PIN, CAN, MRZ or PUK run pace-tool. Here you can
+enter APDUs which are to be converted according to the secure messaging
+parameter and to be sent to the card. Herefor insert the APDU in hex (upper or
+lower case) with a colon to separate the bytes or without it. So to read the
+current selected file both of these forms would be valid:
+00:b0:02:00:00
+00B0020000
+To pass a secret to pace-tool, the command line parameters or the environment
+variables PIN/CAN/MRZ/PUK/NEWPIN can be used. If none of these options is used,
+pace-tool will show a password prompt.
+
+
+@section q QUESTIONS
+For questions, please email me.
+
+@author Frank Morgner <morgner@informatik.hu-berlin.de>
+*/