From 414a011b80bbf88c8357e0b3edd3b40c8b5b462b Mon Sep 17 00:00:00 2001 From: frankmorgner Date: Mon, 9 Apr 2012 13:36:17 +0000 Subject: [PATCH] updated documentation git-svn-id: https://vsmartcard.svn.sourceforge.net/svnroot/vsmartcard@735 96b47cad-a561-4643-ad3b-153ac7d7599c --- ccid/doc/README.rst | 36 ++++++++++++++++++------------------ ccid/doc/autotools.rst | 4 ++-- 2 files changed, 20 insertions(+), 20 deletions(-) diff --git a/ccid/doc/README.rst b/ccid/doc/README.rst index 301a72c..aaa8287 100644 --- a/ccid/doc/README.rst +++ b/ccid/doc/README.rst @@ -8,7 +8,7 @@ ******************************************************************************** -CCID Emulator +USB CCID Emulator ******************************************************************************** :Author: @@ -18,39 +18,39 @@ CCID Emulator :Tested Platforms: Linux (Debian, Ubuntu, OpenMoko) -Welcome to the CCID Emulator. The purpose of the CCID Emulator is to forward +Welcome to the USB CCID Emulator. The purpose of the USB CCID Emulator is to forward a PC/SC smartcard reader as a standard USB CCID reader. If the machine running -the CCID Emulator is in USB device mode, a local reader is forwareded via USB +the USB CCID Emulator is in USB device mode, a local reader is forwareded via USB to another machine. If in USB host mode, a USB CCID reader is virtually plugged -into the machine running the CCID Emulator. Applications on Windows and -Unix-like systems can access the CCID Emulator through PC/SC as if it were a +into the machine running the USB CCID Emulator. Applications on Windows and +Unix-like systems can access the USB CCID Emulator through PC/SC as if it were a real smart card reader. -The CCID Emulator accesses a smart card through a local reader. Simple +The USB CCID Emulator accesses a smart card through a local reader. Simple commands such as transmitting an APDU (``SCardTransmit`` and accordingly ``PC_to_RDR_XfrBlock``) are directly forwarded to the local reader/smart card. -CCID Emulator can perform secure PIN verification and modification +USB CCID Emulator can perform secure PIN verification and modification (``FEATURE_VERIFY_PIN_DIRECT`` or ``FEATURE_MODIFY_PIN_DIRECT`` and accordingly -``PC_to_RDR_Secure``). Moreover the CCID Emulator has support the for Password +``PC_to_RDR_Secure``). Moreover the USB CCID Emulator has support the for Password Authenticated Connection Establishment (PACE) using |npa| -(``FEATURE_EXECUTE_PACE``). Thus CCID Emulator can be used with the German +(``FEATURE_EXECUTE_PACE``). Thus USB CCID Emulator can be used with the German identity card ("neuer Personalausweis", nPA) similar to a "Standardleser" (CAT-S) or "Komfortleser" (CAT-K). -The CCID Emulator is implemented using GadgetFS_. Some fragments of the source +The USB CCID Emulator is implemented using GadgetFS_. Some fragments of the source code are based on the GadgetFS example and on the source code of the OpenSC_ tools. .. include:: autotools.rst -Running the CCID Emulator has the following dependencies: +Running the USB CCID Emulator has the following dependencies: - Linux Kernel with GadgetFS_ - OpenSC_ - |npa| (only if support for PACE is enabled) -Whereas using the CCID Emulator on the host system as smart card reader only +Whereas using the USB CCID Emulator on the host system as smart card reader only needs a usable PC/SC middleware with USB CCID driver. This is the case for most modern Windows and Unix-like systems by default. @@ -78,7 +78,7 @@ loading the module, you maybe want to check out `this patch Hints on OpenSC --------------- -Without the |npa| the CCID Emulator links against libopensc, which is +Without the |npa| the USB CCID Emulator 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 :file:`libopensc.so`). Here @@ -94,7 +94,7 @@ is an example of how to get the standard installation of OpenSC_:: make install Now :file:`libopensc.so` should be located in ``$PREFIX/lib``. Here is how to -configure the CCID Emulator to use it:: +configure the USB CCID Emulator to use it:: ./configure OPENSC_LIBS="-L$PREFIX/lib -lopensc" @@ -103,16 +103,16 @@ configure the CCID Emulator to use it:: Usage ===== -The CCID Emulator has various command line options to customize the appearance on -the USB host. In order to run the CCID Emulator GadgetFS_ must be loaded and -mounted. The CCID Emulator is compatible with the unix driver libccid_ and the +The USB CCID Emulator has various command line options to customize the appearance on +the USB host. In order to run the USB CCID Emulator GadgetFS_ must be loaded and +mounted. The USB CCID Emulator is compatible with the unix driver libccid_ and the windows smart card driver. To initialize PACE using the PC/SC API you need to patch libccid and pcsc-lite (see directory patches). .. program-output:: ccid-emulator --help cats-test can be used to test the PACE capabilities of a smart card reader with -PACE support (such as the CCID Emulator or any other "Standardleser" CAT-S or +PACE support (such as the USB CCID Emulator or any other "Standardleser" CAT-S or "Komfortleser" CAT-C) via PC/SC. .. program-output:: cats-test diff --git a/ccid/doc/autotools.rst b/ccid/doc/autotools.rst index c58fa43..1b600d7 100644 --- a/ccid/doc/autotools.rst +++ b/ccid/doc/autotools.rst @@ -4,7 +4,7 @@ Installation ============= -The CCID Emulator uses the GNU Build System to compile and install. If you are +The USB CCID Emulator uses the GNU Build System to compile and install. If you are unfamiliar 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 :file:`ccid-emulator` to @@ -13,7 +13,7 @@ get the missing standard auxiliary files:: autoreconf -i To configure (:command:`configure --help` lists possible options), build and -install the CCID Emulator now do the following:: +install the USB CCID Emulator now do the following:: ./configure make