/[pcsclite]/trunk/Drivers/ccid/README

Diff of /trunk/Drivers/ccid/README

Parent Directory | Revision Log | View Patch Patch

-revision 467 by rousseau,
Tue Sep 23 07:54:56 2003 UTC
+revision 1506 by rousseau,
Wed May  4 09:30:13 2005 UTC
 Line 6 
 USB CCID IFD Handler
  specifications from the USB working group.
- Author:
+ Authors:
- =======
+ ========
  - Ludovic Rousseau <ludovic.rousseau@free.fr>
+ - Carlos Prados for the PPS and ATR parsing code (taken from his
+   towitoto driver) in towitoko/ directory.
+ - Olaf Kirch for the T=1 TPDU code (from the OpenCT package) in openct/
+   directory. I (Ludovic Rousseau) greatly improved this code.
  Supported CCID readers:
  =======================
  (in alphabetical order)
+ - Advanced Card Systems ACR 38 [16]
+   old versions of this reader have a bug: the reader do timeout when a
+   special USB frame is sent from the reader. If the frame size if a
+   multiple of wMaxPacketSize the communication is stopped.
+ - Cherry XX33 keyboard [?]
+ - Dell keyboard SK-3106 [?]
+ - Dell smart card reader keyboard [?]
  - Gemplus GemPC 433 SL [2]
  - Gemplus GemPC Key [3]
  - Gemplus GemPC Twin [4]
+ - Kobil KAAN Base [19]
+ - Kobil KAAN Advanced [20]
+ - Kobil KAAN SIM III [21]
+ - Kobil mIDentity [22]
  - OmniKey CardMan 3121 [5]
  - SCM Micro SCR 331 [6]
+   You shall upgrade the firmware [17] using version 5.18 or later.
+ - SCM Micro SCR 331-DI [11]
+   You shall upgrade the firmware [17] using version 6.22 or later.
  - SCM Micro SCR 335 [7]
+   The firmware of this reader can't be upgraded so be sure to buy a
+   recent model with firmware 5.14 or later
- Unsupported CCID readers:
+ - SCM Micro SCR 3310
- =========================
+ - SCM Micro SPR 532 [9]
+   You shall contact Torsten Maykranz <tmaykranz@scmmicro.de> to get a
- - LTC31 from C3PO [8]
+   firmware upgrade.
-   Communication errors between the card and the reader. Some cards can't
-   send an ATR.  I have the exact same symptoms with the Windows driver
-   provided by C3PO.
+ Should work but untested by me:
+ ===============================
+ I would like to get these readers to perform test and validation and
+ move them in the supported list above. If you are one of the
+ manufacturers, please, contact me.
+ - Cherry XX44 keyboard (SmartBoard G83-6744) [18]
+ - ActivCard USB reader 2.0 [10]
+ - C3PO LTC32 [13]
+ - SCM Micro SCR 333 [15]
+ - Silitek SK-3105 keyboard [12] or C3PO TLTC2USB [14]
+ Unsupported or partly supported CCID readers:
+ =============================================
+ - C3PO LTC31 [8]
+     The reader works fine with Linux kernel 2.4 but does not with Linux
+     kernel 2.6. The ioctl() syscall returns EINVAL (Invalid argument)
  Supported operating systems:
-Line 41 
 Supported operating systems:
+Line 78 
 Supported operating systems:
    to libusb)
+ Debug informations:
+ ===================
+ The driver uses the debug function provided by pcscd. So if pcscd sends
+ its debug to stdout (pcscd --foreground) then the CCID will also send
+ its debug to stdout. If pcscd sends its debug to syslog (by default)
+ then the CCID will also send its debug to syslog.
+ You can change the debug level using the Info.plist configuraion file.
+ The Info.plist is installed, by default, in
+ /usr/local/pcsc/drivers/ifd-ccid.bundle/Contents/Info.plist
+ The debug level is set in the ifdLogLevel field. It is a binary OR
+ combinaison of 4 different levels.
+ - 1: critical: important error messages
+ - 2: info:     informative messages like what reader was detected
+ - 4: periodic: periodic info when pcscd test if a card is present (every
+/10 of a second)
+ - 8: comm:     a dump of all the bytes exchanged between the host and the
+                reader
+ By default the debug level is set to 3 (1 + 2) and correspond to the
+ critical and info levels.
+ You have to restart the driver so it read the configuration file again
+ and use the new debug level value.  To restart the driver you just need
+ to unplug all your CCID readers so the the driver is unloaded and then
+ replug your readers. You can also restart pcscd.
  Known problems:
  ===============
- All platforms
+ MacOSX libusb
-     T=1 and TPDU
+ """""""""""""
-     """"""""""""
+     There is a bug in libusb that crash the libusb library when you
-       I do not yet included support of T=1 cards when the reader is in
+     unplug a reader and replug it in another USB socket.  So if you
-       TPDU mode.
+     unplug a reader replug it in the same USB socket.
-       If you have a T=1 card I recommand you to use a reader working in
-       APDU mode. T=1 and TPDU will be supported in a future version of
+     see http://sourceforge.net/tracker/index.php?func=detail&aid=886778&group_id=1674&atid=101674
-       the driver.
-     readers enumeration
-     """""""""""""""""""
-       You may have wrong reader identification if you connect two or
-       more reader at the exact same time.
-       The daemon pcscd and the CCID driver do not list connected readers
-       in the same order. The driver has no way to know which reader has
-       been detected as a new reader by pcscd.
-       So if you plug two readers at the same time (for example if you
-       start pcscd with two readers connected or if you plug a USB hub
-       with two readers on the hub) you may have this (with two readers
-       foo and bar):
-       - pcscd scans the USB bus and finds a new CCID reader foo and
-         calls the driver
-       - the CCID driver scan the USB bus and finds a new different
-         reader bar
-       - pcscd continues scanning the USB bus and finds the second reader
-         bar and calls the driver
-       - the CCID driver scan the USB bus and finds an unused reader foo.
-         Now the reader foo will be called bar by pcscd and bar will be
-         called foo. This may not be a problem if the two readers have
-         the same name. But it is strange to insert a card in the
-         physical reader foo and see pcscd detect the card insertion in
-         the reader he calls bar.
-         The solution is to use IFDHCreateChannelByName() instead of
-         IFDHCreateChannel() and specify the USB device to use. But pcscd
-         does not implement IFDHCreateChannelByName() yet. Maybe in the
-         future.
-         Another solution is to plug readers one after the other and not
-         at the same time.
- MacOS X/Darwin
-     hotplug
-     """""""
-       Due to libusb work in progress the driver may crash on a reader
-       insertion after a few insert/remove actions.
-       So if your reader is always connected you should not have
-       problems.
-       A new version of libusb should fix this bug
- *BSD
-     libusb
-     """"""
-       The libusb does not yet support USB interrupt endpoints. You will
-       notice that the driver will stop working as soon as you insert a
-       card in the reader.
-       A new version of libusb should fix this bug.
  Licence:
  ========
-   This program is free software; you can redistribute it and/or modify
+   This library is free software; you can redistribute it and/or modify it
- it under the terms of the GNU General Public License as published by the
+ under the terms of the GNU Lesser General Public License as published by
- Free Software Foundation; either version 2 of the License, or (at your
+ the Free Software Foundation; either version 2.1 of the License, or (at
- option) any later version.
+ your option) any later version.
-   This program is distributed in the hope that it will be useful, but
+   This library is distributed in the hope that it will be useful, but
  WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser
  General Public License for more details.
-   You should have received a copy of the GNU General Public License
+   You should have received a copy of the GNU Lesser General Public License
- along with this program; if not, write to the Free Software Foundation,
+ along with this library; if not, write to the Free Software Foundation,
- Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
+ Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307  USA
  History:
  ========
+.9.3 - 14 March 2005, Ludovic Rousseau
+     - change the licence from GNU GPL to GNU Lesser GPL (LGPL)
+     - add support for ACS ACR 38, Kobil KAAN Base, Kobil KAAN Advanced,
+       Kobil KAAN SIM III, Kobil KAAN mIDentity, SCM Micro SCR 331,
+       SCM Micro SCR 331-DI, SCM Micro SCR 335, SCM Micro SCR 3310,
+       SCM Micro SCR 532, Cherry XX44 readers
+     - improve communication speed with readers featuring "Automatic PPS
+       made by the CCID"
+     - switch the Cherry xx33 reader in ISO mode if power up in EMV mode
+       fails.
+     - add support of character level readers. Thanks to O2Micro for the
+       patch
+     - add support for the O2Micro OZ776S reader but the reader firmware
+       is still bogus
+     - check firmware version to avoid firmwares with bugs. You can still
+       use a bogus firmware by setting DRIVER_OPTION_USE_BOGUS_FIRMWARE
+       in Info.plist
+     - some minor bugs removed
+.9.2 - 15 August 2004, Ludovic Rousseau
+     - T=1 TPDU code:
+       . the work on T=1 TPDU code was possible thanks to Gemplus
+         validation team who helped me test, debug and bring the code to
+         an EMV validation level. Thanks to J�r�me, Jean-Yves, Xavier and
+         the Gemplus readers department
+       . error code was not checked correctly
+       . avoid a (nearly) infinite loop when resynch are needed.
+       . correctly initialise an internal value to allow more than one
+         reader to work
+     - multi-slots readers
+       . add support for multi-slots readers. The only one I have is a
+         SCM Micro SCR 331-DI with a contact and a contactless interface.
+         The contactless interface may or may not work for you since the
+         reader uses proprietary (undocumented) commands.
+     - GemPC Twin serial reader
+       . perform a command (get the reader firmware) to be sure a GemPC
+         Twin (serial or pcmcia) reader is connected
+       . use a dynamic timeout when reading the serial port.
+         The first timeout used when detecting the reader is 2 seconds to
+         not wait too long if no reader is connected. Later timeouts are
+         set to 1 minute to allow long time APDU.
+     - use `pkg-config libpcsclite --cflags` to locate the pcsc-lite
+       header files
+     - use `pkg-config --print-errors --atleast-version=1.2.9-beta5 libpcsclite`
+       to test the pcsc-lite version
+     - code improvements thanks to the splint tool (http://www.splint.org/)
+.9.1 - 1 July 2004, Ludovic Rousseau
+     - I forgot to define IFD_PARITY_ERROR in a .h file
+.9.0 - 1 July 2004, Ludovic Rousseau
+     - The T=1 TPDU automata from Carlos Prados' Towitoko driver is very
+       limited and do not support error management mechanisms.
+       I then used the T=1 TPDU automata from OpenCT (OpenSC project).
+       This automata is much more powerful but still lacks a lot of error
+       management code.
+       I then added all the needed code to reach the quality level
+       requested by the EMV standard.
+     - add support for new readers:
+       . Advanced Card Systems ACR 38
+       . Cherry XX33
+       . Dell keyboard SK-3106
+       . Dell smart card reader keyboard
+       . SCR 333
+     - add support of multi procotol cards (T=0 and T=1)
+     - the debug level is now dynamic and set in the Info.plist file (no
+       need to recompile the driver any more)
+     - add support for the libusb naming scheme: usb:%04x/%04x:libusb:%s
+     - INSTALL: add a "configuring the driver for the serial reader
+       (GemPC Twin)" part
+     - use `pkg-config libpcsclite --variable=usbdropdir` so you do not
+       have to use --enable-usbdropdir=DIR or --enable-ccidtwindir=DIR
+       even if pcscd does not use the default /usr/local/pcsc/drivers
+     - add support of IOCTL_SMARTCARD_VENDOR_IFD_EXCHANGE and
+       IOCTL_SMARTCARD_VENDOR_VERIFY_PIN in IFDHControl()
+     - read ifdDriverOptions from Info.plist to limit the use of
+       IOCTL_SMARTCARD_VENDOR_IFD_EXCHANGE (idea from Peter Williams)
+     - provide an example of use of SCardControl()
+       IOCTL_SMARTCARD_VENDOR_IFD_EXCHANGE and
+       IOCTL_SMARTCARD_VENDOR_VERIFY_PIN in example/
+     - add a --enable-pcsclite option (default to yes) so that the driver
+       can be compiled for a different framework (one needing
+       tokenparser.l like Solaris)
+     - Reset action is power off and power on, not just power on
+     - use the include files from pcsc-lite
+     - add a mechanism to allow power on at 1.8V, 3V and then 5V as
+       specified by ISO 7816. We still use 5V for now to avoid problems
+       with non ISO compliant cards
+.4.1 - 14 February 2004, Ludovic Rousseau
+     - distribute missing files readers/supported_readers.txt and
+       src/create_Info_plist.pl
+       'make install' failed because of this.
+.4.0 - 13 February 2004, Ludovic Rousseau
+     - support of T=1 with TPDU readers. A lot of the T=1 code comes from
+       Carlos Prados towitoko driver.
+       My code is GNU GPL, his code is GNU LGPL so the global driver is
+       GNU GPL
+     - PPS negotiation if the reader does not do it automatically
+     - add support for the Silitek SK-3105 keyboard. It's a USB device
+       with multiple interfaces
+     - use the create_Info_plist.pl script to generate the installed
+       Info.plist from an Info.plist template and a list of supported
+       readers. The Info.plist was too "complex" to maintain by hand
+       since it now contains 11 entries
+     - add support of IFDHCreateChannelByName to avoid wrong reader
+       enumeration. This is not complete if you have multiple _identical_
+       readers. You need to use a > 1.2.0 pcsc-lite version (not yet
+       released at that time)
+     - build but do not install the serial ccidtwin driver by default
+       since it is useless on computers without a serial port or without
+       this reader for example.
+     - read and write timeouts are not symmetric. write timout can be
+       shorter since the reader and card is not supposed to do anything
+       before receiving (write) a command
+     - do not try to find usb.h and other libusb files if
+       --disable-libusb is used. Needed if you only want to build the
+       serial driver.  Thanks to Niki Waibel for the patch
+     - add a --enable-ccidtwindir argument to ./configure to specify the
+       serial GemPC Twin installation directory
+     - debug and code improvements and simplifications
+.3.2 - 4 November 2003, Ludovic Rousseau
+     - src/commands.c: correct a stupid bug that occurs with an APDU with
+bytes response.
+     - Info.plist: add SPR 532 in list of supported readers
+     - parse.c: do not exit if the InterfaceClass is 0xFF (proprietary).
+       It is the case with old readers manufactured before the final
+       release of the CCID specs.
+     - move LTC31 reader from unsupported to supported reader list. It
+       was my f ault since in used odd INS byte in my test applet and odd
+       INS bytes are forbidden by ISO 7816-4 ch. 5.4.2 Instruction byte.
+       Thanks to Josep Mon� s Teixidor for pointing the problem.
+     - src/commands.c: comment out the automatic GET RESPONSE part. I
+       don't think it should be in the driver. Maybe in pcscd instead?
 .3.1 - 23 September 2003, Ludovic Rouseau
      - add --enable-multi-thread (enabled by default) for thread safe
        support an APDU multiplexing. You will need pcsc-lite-1.2.0-rc3 or
-Line 174 
 Bibliography:
+Line 325 
 Bibliography:
  [5] http://www.omnikey.com/en/produkt_details.php3?produkt=1&variante=47
  [6] http://www.scmmicro.com/security/SCR331.html
  [7] http://www.scmmicro.com/security/SCR335.html
- [8] http://www.c3po.es/pcsc.htm
+ [8] http://www.c3po.es/ltc31.html
+ [9] http://www.scmmicro.com/security/SPR532.html
+ [10] http://www.activcard.com/products/usb_reader.html
+ [11] http://www.scmmicro.com/security/SCR331-DI.html
+ [12] http://www.silitek.com/prod/getProduct.do?xml_id=4_2&menu_id=4_2_8&cid=1_8_5
+ [13] http://www.c3po.es/ltc32.html
+ [14] http://www.c3po.es/tltc2usb.html
+ [15] http://www.scmmicro.com/security/SCR333.html
+ [16] http://www.acs.com.hk/Product_Readers.asp?productID=59&PCate=Products_PC_Linked_SmartCard_Readers
+ [17] http://www.scmmicro.com/support/pcs_product_drivers.html
+ [18] http://www.cherrycorp.com/english/advanced-line/advanced-line_smartboard_g83-6744.htm
+ [19] http://www.kobil.com/e/products/smartcard/kaan-base.php
+ [20] http://www.kobil.com/e/products/smartcard/kaan-advanced.php
+ [21] http://www.kobil.com/d/products/smartcard/kaansim3.php
+ [22] http://www.kobil.com/e/products/index.php?s=midentity
  $Id$

 Legend:



Removed from v.467
 


changed lines


 
Added in v.1506
 Legend:



Removed from v.467
 


changed lines


 
Added in v.1506
-Removed from v.467
+Added in v.1506

	ViewVC Help
Powered by ViewVC 1.1.5