Contents of /trunk/Drivers/ccid/README

USB CCID IFD Handler
====================

  This package provides the source code for a generic USB CCID
(Chip/Smart Card Interface Devices) driver. See [1] for the USB CCID
specifications from the USB working group.


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)
- 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]
- OmniKey CardMan 3121 [5]


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.

- ActivCard USB reader 2.0 [10]
- C3PO LTC32 [13]
- SCM Micro SCR 331-DI [11]
- SCM Micro SCR 333 [15]
- Silitek SK-3105 keyboard [12] or C3PO TLTC2USB [14]


Unsupported or partly supported CCID readers:
=============================================

- Advanced Card Systems ACR 38 [16]
- SCM Micro SCR 335 [7]
- SCM Micro SCR 331 [6]
- SCM Micro SPR 532 [9]
    These readers 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. You should contact the reader vendor to
    upgrade the firmware of the reader or replace the reader.

- 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:
============================

- GNU/Linux (libusb 0.1.7)
- MacOS X/Darwin (libusb 0.1.8beta, CVS snapshot. See "Known problems")
  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
               1/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:
===============

MacOSX libusb
"""""""""""""
    There is a bug in libusb that crash the libusb library when you
    unplug a reader and replug it in another USB socket.  So if you
    unplug a reader replug it in the same USB socket.

    see http://sourceforge.net/tracker/index.php?func=detail&aid=886778&group_id=1674&atid=101674


Licence:
========

  This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by the
Free Software Foundation; either version 2 of the License, or (at your
option) any later version.

  This program 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
General Public License for more details.

  You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software Foundation,
Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA


History:
========

0.9.1 - 1 July 2004, Ludovic Rousseau
    - I forgot to define IFD_PARITY_ERROR in a .h file

0.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


0.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.

0.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

0.3.2 - 4 November 2003, Ludovic Rousseau
    - src/commands.c: correct a stupid bug that occurs with an APDU with
      2 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?

0.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
      above to use this feature.
    - add --enable-libusb=PATH option is your libusb is not installed in
      /usr or /usr/local
    - honor DESTDIR in install rules (closes [ #300110 ]). Thanks to
      Ville Skytt� for the patch.
    - src/ccid.c: do not switch the GemPC Key and GemPC Twin in APDU
      mode since it also swicth in EMV mode and may not work with non
      EMV cards
    - src/ccid_serial.c: complete reimplementation of the Twin serial
      protocol using a finite state automata (code much simpler)

0.3.0 - 10 September 2003, Ludovic Rousseau
    - support of GemPC Twin connected to a serial port. Thanks to Niki
      W. Waibel for a working prototype.
    - support of auto voltage at power up if the reader support it
      instead of forcing a 5V in all cases.
    - support of APDU mode instead of just TPDU if the reader support
      it. Thanks to Jean-Luc Giraud for the idea and inspiration I got
      from his "concurrent" driver.
    - support of "time request" from the card.
    - parse: new indentation for more readability of supported features.
    - switch the GemPC Key and GemPC Twin in APDU mode since they
      support it but do not announce it in the dwFeatures.
    - new build process using autoconf/automake.

0.2.0 - 26 August 2003, Ludovic Rousseau
    - Works under MacOS X
    - Info.plist: use an <array></array> for the alias enumeration
    - Makefile rework for *BSD and MacOS X

0.1.0 - 13 August 2003, Ludovic Rousseau
    - First public release


Bibliography:
=============

[1] http://www.usb.org/developers/devclass_docs/ccid_classspec_1_00a.pdf
[2] http://www.gemplus.com/products/gempc433/
[3] http://www.gemplus.com/products/gempckey/
[4] http://www.gemplus.com/products/gempctwin/
[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/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/products_readers_acr38.asp

$Id$

 vim:ts=20
1	rousseau	269	USB CCID IFD Handler
2			====================
3
4			This package provides the source code for a generic USB CCID
5			(Chip/Smart Card Interface Devices) driver. See [1] for the USB CCID
6	rousseau	273	specifications from the USB working group.
7	rousseau	269
8
9	rousseau	697	Authors:
10			========
11	rousseau	269
12			- Ludovic Rousseau <ludovic.rousseau@free.fr>
13	rousseau	1015	- Carlos Prados for the PPS and ATR parsing code (taken from his
14			towitoto driver) in towitoko/ directory.
15			- Olaf Kirch for the T=1 TPDU code (from the OpenCT package) in openct/
16			directory. I (Ludovic Rousseau) greatly improved this code.
17	rousseau	269
18
19			Supported CCID readers:
20			=======================
21
22	rousseau	273	(in alphabetical order)
23	rousseau	969	- Cherry XX33 keyboard [?]
24			- Dell keyboard SK-3106 [?]
25			- Dell smart card reader keyboard [?]
26	rousseau	273	- Gemplus GemPC 433 SL [2]
27			- Gemplus GemPC Key [3]
28			- Gemplus GemPC Twin [4]
29			- OmniKey CardMan 3121 [5]
30	rousseau	606
31
32			Should work but untested by me:
33			===============================
34
35			I would like to get these readers to perform test and validation and
36			move them in the supported list above. If you are one of the
37			manufacturers, please, contact me.
38
39	rousseau	708	- ActivCard USB reader 2.0 [10]
40	rousseau	709	- C3PO LTC32 [13]
41	rousseau	666	- SCM Micro SCR 331-DI [11]
42	rousseau	709	- SCM Micro SCR 333 [15]
43			- Silitek SK-3105 keyboard [12] or C3PO TLTC2USB [14]
44	rousseau	269
45
46	rousseau	969	Unsupported or partly supported CCID readers:
47			=============================================
48	rousseau	269
49	rousseau	1165	- Advanced Card Systems ACR 38 [16]
50			- SCM Micro SCR 335 [7]
51			- SCM Micro SCR 331 [6]
52			- SCM Micro SPR 532 [9]
53			These readers do timeout when a special USB frame is sent from the
54			reader. If the frame size if a multiple of wMaxPacketSize the
55			communication is stopped. You should contact the reader vendor to
56			upgrade the firmware of the reader or replace the reader.
57	rousseau	269
58	rousseau	1165	- C3PO LTC31 [8]
59			The reader works fine with Linux kernel 2.4 but does not with Linux
60			kernel 2.6. The ioctl() syscall returns EINVAL (Invalid argument)
61	rousseau	269
62	rousseau	1165
63	rousseau	321	Supported operating systems:
64			============================
65
66			- GNU/Linux (libusb 0.1.7)
67			- MacOS X/Darwin (libusb 0.1.8beta, CVS snapshot. See "Known problems")
68			to libusb)
69
70
71	rousseau	862	Debug informations:
72			===================
73
74			The driver uses the debug function provided by pcscd. So if pcscd sends
75			its debug to stdout (pcscd --foreground) then the CCID will also send
76			its debug to stdout. If pcscd sends its debug to syslog (by default)
77			then the CCID will also send its debug to syslog.
78
79			You can change the debug level using the Info.plist configuraion file.
80			The Info.plist is installed, by default, in
81			/usr/local/pcsc/drivers/ifd-ccid.bundle/Contents/Info.plist
82
83			The debug level is set in the ifdLogLevel field. It is a binary OR
84			combinaison of 4 different levels.
85			- 1: critical: important error messages
86			- 2: info: informative messages like what reader was detected
87			- 4: periodic: periodic info when pcscd test if a card is present (every
88			1/10 of a second)
89			- 8: comm: a dump of all the bytes exchanged between the host and the
90			reader
91
92			By default the debug level is set to 3 (1 + 2) and correspond to the
93			critical and info levels.
94
95			You have to restart the driver so it read the configuration file again
96			and use the new debug level value. To restart the driver you just need
97			to unplug all your CCID readers so the the driver is unloaded and then
98			replug your readers. You can also restart pcscd.
99
100
101	rousseau	321	Known problems:
102			===============
103
104	rousseau	1165	MacOSX libusb
105	rousseau	969	"""""""""""""
106			There is a bug in libusb that crash the libusb library when you
107			unplug a reader and replug it in another USB socket. So if you
108			unplug a reader replug it in the same USB socket.
109
110			see http://sourceforge.net/tracker/index.php?func=detail&aid=886778&group_id=1674&atid=101674
111
112
113	rousseau	273	Licence:
114			========
115
116	rousseau	269	This program is free software; you can redistribute it and/or modify
117			it under the terms of the GNU General Public License as published by the
118			Free Software Foundation; either version 2 of the License, or (at your
119			option) any later version.
120
121			This program is distributed in the hope that it will be useful, but
122			WITHOUT ANY WARRANTY; without even the implied warranty of
123			MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
124			General Public License for more details.
125
126			You should have received a copy of the GNU General Public License
127			along with this program; if not, write to the Free Software Foundation,
128			Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
129
130
131			History:
132			========
133
134	rousseau	1018	0.9.1 - 1 July 2004, Ludovic Rousseau
135			- I forgot to define IFD_PARITY_ERROR in a .h file
136
137	rousseau	1015	0.9.0 - 1 July 2004, Ludovic Rousseau
138			- The T=1 TPDU automata from Carlos Prados' Towitoko driver is very
139			limited and do not support error management mechanisms.
140			I then used the T=1 TPDU automata from OpenCT (OpenSC project).
141			This automata is much more powerful but still lacks a lot of error
142			management code.
143			I then added all the needed code to reach the quality level
144			requested by the EMV standard.
145			- add support for new readers:
146			. Advanced Card Systems ACR 38
147			. Cherry XX33
148			. Dell keyboard SK-3106
149			. Dell smart card reader keyboard
150			. SCR 333
151			- add support of multi procotol cards (T=0 and T=1)
152			- the debug level is now dynamic and set in the Info.plist file (no
153			need to recompile the driver any more)
154			- add support for the libusb naming scheme: usb:%04x/%04x:libusb:%s
155			- INSTALL: add a "configuring the driver for the serial reader
156			(GemPC Twin)" part
157			- use `pkg-config libpcsclite --variable=usbdropdir` so you do not
158			have to use --enable-usbdropdir=DIR or --enable-ccidtwindir=DIR
159			even if pcscd does not use the default /usr/local/pcsc/drivers
160			- add support of IOCTL_SMARTCARD_VENDOR_IFD_EXCHANGE and
161			IOCTL_SMARTCARD_VENDOR_VERIFY_PIN in IFDHControl()
162			- read ifdDriverOptions from Info.plist to limit the use of
163			IOCTL_SMARTCARD_VENDOR_IFD_EXCHANGE (idea from Peter Williams)
164			- provide an example of use of SCardControl()
165			IOCTL_SMARTCARD_VENDOR_IFD_EXCHANGE and
166			IOCTL_SMARTCARD_VENDOR_VERIFY_PIN in example/
167			- add a --enable-pcsclite option (default to yes) so that the driver
168			can be compiled for a different framework (one needing
169			tokenparser.l like Solaris)
170			- Reset action is power off and power on, not just power on
171			- use the include files from pcsc-lite
172			- add a mechanism to allow power on at 1.8V, 3V and then 5V as
173			specified by ISO 7816. We still use 5V for now to avoid problems
174			with non ISO compliant cards
175
176
177	rousseau	703	0.4.1 - 14 February 2004, Ludovic Rousseau
178			- distribute missing files readers/supported_readers.txt and
179			src/create_Info_plist.pl
180			'make install' failed because of this.
181
182	rousseau	697	0.4.0 - 13 February 2004, Ludovic Rousseau
183			- support of T=1 with TPDU readers. A lot of the T=1 code comes from
184			Carlos Prados towitoko driver.
185			My code is GNU GPL, his code is GNU LGPL so the global driver is
186			GNU GPL
187			- PPS negotiation if the reader does not do it automatically
188			- add support for the Silitek SK-3105 keyboard. It's a USB device
189			with multiple interfaces
190			- use the create_Info_plist.pl script to generate the installed
191			Info.plist from an Info.plist template and a list of supported
192			readers. The Info.plist was too "complex" to maintain by hand
193			since it now contains 11 entries
194			- add support of IFDHCreateChannelByName to avoid wrong reader
195			enumeration. This is not complete if you have multiple _identical_
196			readers. You need to use a > 1.2.0 pcsc-lite version (not yet
197			released at that time)
198			- build but do not install the serial ccidtwin driver by default
199			since it is useless on computers without a serial port or without
200			this reader for example.
201			- read and write timeouts are not symmetric. write timout can be
202			shorter since the reader and card is not supposed to do anything
203			before receiving (write) a command
204			- do not try to find usb.h and other libusb files if
205			--disable-libusb is used. Needed if you only want to build the
206			serial driver. Thanks to Niki Waibel for the patch
207			- add a --enable-ccidtwindir argument to ./configure to specify the
208			serial GemPC Twin installation directory
209			- debug and code improvements and simplifications
210
211	rousseau	552	0.3.2 - 4 November 2003, Ludovic Rousseau
212			- src/commands.c: correct a stupid bug that occurs with an APDU with
213			2 bytes response.
214			- Info.plist: add SPR 532 in list of supported readers
215			- parse.c: do not exit if the InterfaceClass is 0xFF (proprietary).
216			It is the case with old readers manufactured before the final
217			release of the CCID specs.
218			- move LTC31 reader from unsupported to supported reader list. It
219			was my f ault since in used odd INS byte in my test applet and odd
220			INS bytes are forbidden by ISO 7816-4 ch. 5.4.2 Instruction byte.
221			Thanks to Josep Mon� s Teixidor for pointing the problem.
222			- src/commands.c: comment out the automatic GET RESPONSE part. I
223			don't think it should be in the driver. Maybe in pcscd instead?
224
225	rousseau	467	0.3.1 - 23 September 2003, Ludovic Rouseau
226			- add --enable-multi-thread (enabled by default) for thread safe
227			support an APDU multiplexing. You will need pcsc-lite-1.2.0-rc3 or
228			above to use this feature.
229			- add --enable-libusb=PATH option is your libusb is not installed in
230			/usr or /usr/local
231			- honor DESTDIR in install rules (closes [ #300110 ]). Thanks to
232			Ville Skytt� for the patch.
233			- src/ccid.c: do not switch the GemPC Key and GemPC Twin in APDU
234			mode since it also swicth in EMV mode and may not work with non
235			EMV cards
236			- src/ccid_serial.c: complete reimplementation of the Twin serial
237			protocol using a finite state automata (code much simpler)
238
239	rousseau	423	0.3.0 - 10 September 2003, Ludovic Rousseau
240			- support of GemPC Twin connected to a serial port. Thanks to Niki
241			W. Waibel for a working prototype.
242			- support of auto voltage at power up if the reader support it
243			instead of forcing a 5V in all cases.
244			- support of APDU mode instead of just TPDU if the reader support
245			it. Thanks to Jean-Luc Giraud for the idea and inspiration I got
246			from his "concurrent" driver.
247	rousseau	425	- support of "time request" from the card.
248	rousseau	423	- parse: new indentation for more readability of supported features.
249			- switch the GemPC Key and GemPC Twin in APDU mode since they
250			support it but do not announce it in the dwFeatures.
251			- new build process using autoconf/automake.
252
253	rousseau	342	0.2.0 - 26 August 2003, Ludovic Rousseau
254			- Works under MacOS X
255			- Info.plist: use an <array></array> for the alias enumeration
256			- Makefile rework for *BSD and MacOS X
257
258	rousseau	273	0.1.0 - 13 August 2003, Ludovic Rousseau
259			- First public release
260	rousseau	269
261
262	rousseau	425	Bibliography:
263			=============
264	rousseau	269
265			[1] http://www.usb.org/developers/devclass_docs/ccid_classspec_1_00a.pdf
266	rousseau	273	[2] http://www.gemplus.com/products/gempc433/
267			[3] http://www.gemplus.com/products/gempckey/
268	rousseau	269	[4] http://www.gemplus.com/products/gempctwin/
269	rousseau	273	[5] http://www.omnikey.com/en/produkt_details.php3?produkt=1&variante=47
270			[6] http://www.scmmicro.com/security/SCR331.html
271			[7] http://www.scmmicro.com/security/SCR335.html
272	rousseau	709	[8] http://www.c3po.es/ltc31.html
273	rousseau	553	[9] http://www.scmmicro.com/security/SPR532.html
274	rousseau	606	[10] http://www.activcard.com/products/usb_reader.html
275	rousseau	666	[11] http://www.scmmicro.com/security/SCR331-DI.html
276	rousseau	677	[12] http://www.silitek.com/prod/getProduct.do?xml_id=4_2&menu_id=4_2_8&cid=1_8_5
277	rousseau	709	[13] http://www.c3po.es/ltc32.html
278			[14] http://www.c3po.es/tltc2usb.html
279			[15] http://www.scmmicro.com/security/SCR333.html
280	rousseau	969	[16] http://www.acs.com.hk/products_readers_acr38.asp
281	rousseau	269
282			$Id$
283
284			vim:ts=20
Name	Value
svn:eol-style	native
svn:keywords	Author Date Id Revision