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

Contents of /trunk/Drivers/ccid/README

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1314 - (hide annotations) (download)
Thu Jan 13 10:48:47 2005 UTC (8 years, 4 months ago) by rousseau
File size: 13468 byte(s)
move the SCM Micro readers from unsupported to supported list and
document how to upgrade the firmwares

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

Properties

Name Value
svn:eol-style native
svn:keywords Author Date Id Revision

  ViewVC Help
Powered by ViewVC 1.1.5