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

Contents of /trunk/Drivers/ccid/README

Parent Directory Parent Directory | Revision Log Revision Log


Revision 2131 - (show annotations) (download)
Thu Aug 10 22:31:08 2006 UTC (6 years, 10 months ago) by rousseau
File size: 21351 byte(s)
Add iDream (or THRC2002-2) to the "Unsupported or partly supported CCID
readers" list.

Thanks to Dr Jean-Pierre Szikora for the report
1 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 specifications from the USB working group.
7
8
9 Authors:
10 ========
11
12 - Ludovic Rousseau <ludovic.rousseau@free.fr>
13 - 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
18
19 Supported CCID readers:
20 =======================
21
22 (in alphabetical order)
23 - ActivCard USB reader 3.0
24 - Advanced Card Systems ACR 38U-CCID [16]
25 old versions of this reader have a bug: the reader do timeout when a
26 special USB frame is sent from the reader. If the frame size if a
27 multiple of wMaxPacketSize the communication is stopped.
28 - Alcor Micro AU9520 [46]
29 - Athena ASE IIIe USB V2 [29]
30 - Athena ASE IIIe KB USB [42]
31 - C3PO LTC31 (new model, USB product id 0x0006) [8]
32 - Cherry XX33 keyboard [?]
33 - Cherry XX44 keyboard (SmartBoard G83-6744) [18]
34 - Cherry SmartTerminal ST2000U [35]
35 - Cherry ST-1044U [27]
36 - Dell keyboard SK-3106 [?]
37 - Dell smart card reader keyboard [?]
38 - Eutron SIM Pocket Combo [25]
39 - Eutron CryptoIdentity [26]
40 - Gemplus GemPC 433 SL [2]
41 - Gemplus GemPC Card [41]
42 - Gemplus GemPC Key [3]
43 - Gemplus GemPC PinPad
44 - Gemplus GemPC Twin [4]
45 - Gemplus GemCore POS Pro
46 - Gemplus GemCore SIM Pro
47 - Kobil KAAN Base [19]
48 - Kobil KAAN Advanced [20]
49 - Kobil KAAN SIM III [21]
50 - Kobil mIDentity [22]
51 - OmniKey CardMan 3121 [5]
52 - SCM Micro SCR 331 [6]
53 You shall upgrade the firmware [17] using version 5.18 or later.
54 - SCM Micro SCR 331-DI [11]
55 You shall upgrade the firmware [17] using version 6.22 or later.
56 - SCM Micro SCR 335 [7]
57 The firmware of this reader can't be upgraded so be sure to buy a
58 recent model with firmware 5.14 or later
59 - SCM Micro SCR 355
60 - SCM Micro SCR 3310 [30]
61 - SCM Micro SCR 3311 [31]
62 - SCM Micro SPR 532 [9]
63 You shall contact Torsten Maykranz <tmaykranz@scmmicro.de> to get a
64 firmware upgrade.
65 - SmartEpad (v 2.0) [32]
66 The firmware gives a very strange description of the reader (like a
67 dwDefaultClock: 1024.000 MHz). So do not expect a perfect behavior.
68 - Verisign Secure Storage Token [24]
69 - Verisign Secure Token [?]
70
71
72 Should work but untested by me:
73 ===============================
74
75 I would like to get these readers to perform test and validation and
76 move them in the supported list above. If you are one of the
77 manufacturers, please, contact me.
78
79 - Axalto Reflex USB v3 [38]
80 - C3PO LTC32 [13]
81 - Gemplus GemPC Express
82 - HP USB Smart Card Keyboard [44]
83 - id3 Semiconductors CL1356D [45] (tested by me but I don't have the
84 reader anymore)
85 - OmniKey CardMan 3021
86 - OmniKey CardMan 3621 [43]
87 - OmniKey CardMan 3821 [37]
88 - OmniKey CardMan 5125 [33]
89 - OmniKey CardMan 6121 [36]
90 - SCM Micro SCR 331-DI NTTCom [23]
91 - SCM Micro SCR 3310-NTTCOM [28]
92 - SCM Micro SCR 3320 [32]
93 - SCM Micro SCR 333 [15]
94 - SCM Micro SDI 010 [39]
95 - SCM SCR 3340 ExpressCard54 [34]
96 - Silitek SK-3105 keyboard [12] or C3PO TLTC2USB [14]
97 - Winbond Electronics (for OEM only) [40]
98
99
100 Unsupported or partly supported CCID readers:
101 =============================================
102
103 - ActivCard USB reader 2.0 [10]
104 The reader do timeout when a special USB frame is sent from the
105 reader. If the frame size if a multiple of wMaxPacketSize the
106 communication is stopped.
107 - C3PO LTC31 (old model, USB product id 0x0003) [8]
108 The reader works fine with Linux kernel 2.4 but does not with Linux
109 kernel 2.6. The ioctl() syscall returns EINVAL (Invalid argument)
110 - iDream (THRC2002-2) [47]
111 PPS fails with a Cryptoflex card
112 powerup fails with a Setcos card
113 does work with the belgium eID (the reader is sold for this
114 application)
115 - RSA SecureID SID800 [24]
116 The USB layer is completely broken. The reader is sometimes not even
117 seen on the USB bus (same problem under Windows). Maybe newer
118 devices will work?
119
120
121 Supported operating systems:
122 ============================
123
124 - GNU/Linux (libusb 0.1.7)
125 - MacOS X/Darwin (libusb 0.1.8beta, CVS snapshot. See "Known problems")
126 to libusb)
127
128
129 Debug informations:
130 ===================
131
132 The driver uses the debug function provided by pcscd. So if pcscd sends
133 its debug to stderr (pcscd --foreground) then the CCID will also send
134 its debug to stderr. If pcscd sends its debug to syslog (by default)
135 then the CCID will also send its debug to syslog.
136
137 You can change the debug level using the Info.plist configuration file.
138 The Info.plist is installed, by default, in
139 /usr/local/pcsc/drivers/ifd-ccid.bundle/Contents/Info.plist
140
141 The debug level is set in the ifdLogLevel field. It is a binary OR
142 combinaison of 4 different levels.
143 - 1: critical: important error messages
144 - 2: info: informative messages like what reader was detected
145 - 4: comm: a dump of all the bytes exchanged between the host and the
146 reader
147 - 8: periodic: periodic info when pcscd test if a card is present (every
148 1/10 of a second)
149
150 By default the debug level is set to 3 (1 + 2) and correspond to the
151 critical and info levels.
152
153 You have to restart the driver so it read the configuration file again
154 and use the new debug level value. To restart the driver you just need
155 to unplug all your CCID readers so the the driver is unloaded and then
156 replug your readers. You can also restart pcscd.
157
158
159 Known problems:
160 ===============
161
162 MacOSX libusb
163 """""""""""""
164 There is a bug in libusb that crash the libusb library when you
165 unplug a reader and replug it in another USB socket. So if you
166 unplug a reader replug it in the same USB socket.
167
168 see http://sourceforge.net/tracker/index.php?func=detail&aid=886778&group_id=1674&atid=101674
169
170
171 Licence:
172 ========
173
174 This library is free software; you can redistribute it and/or modify it
175 under the terms of the GNU Lesser General Public License as published by
176 the Free Software Foundation; either version 2.1 of the License, or (at
177 your option) any later version.
178
179 This library is distributed in the hope that it will be useful, but
180 WITHOUT ANY WARRANTY; without even the implied warranty of
181 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser
182 General Public License for more details.
183
184 You should have received a copy of the GNU Lesser General Public License
185 along with this library; if not, write to the Free Software Foundation,
186 Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
187
188
189 History:
190 ========
191
192 1.0.1 - 22 April 2006, Ludovic Rousseau
193 - add support for Axalto Reflex USB v3, SCM Micro SDI 010, Winbond
194 Electronics W81E381 chipset, Gemplus GemPC Card, Athena ASE IIIe
195 KB USB, OmniKey CardMan 3621
196 - support Solaris (Solaris uses a different libusb)
197 - better documentation for ./configure arguments
198 - improve support of Cherry XX44 keyboard for PIN verify and change
199 (circumvent firmware bugs)
200 - do not use LTPBundleFindValueWithKey() from pcscd since this
201 function has been removed from pcscd API
202 - use -fvisibility=hidden is available to limit the number of
203 exported symbols
204
205
206 1.0.0 - 3 March 2006, Ludovic Rousseau
207 - add support for ActivCard USB Reader 3.0, Athena ASE IIIe USB V2,
208 SCM Micro SCR 355, SCR 3311, SCR 3320, SCR 3340 ExpressCard54,
209 Gemplus GemCore SIM Pro, GemCore POS Pro (serial and USB), GemPC
210 Express (ExpressCard/54 interface), SmartEpad (v 2.0), OmniKey
211 CardMan 5125
212 - greatly improve support of PIN PAD readers. We now support TPDU
213 readers with T=1 cards
214 - use l10n strings for the Gemplus GemPC PIN PAD (it has a screen).
215 Supported languages are: de, en, es, fr, it
216 - rename ACS ACR 38 in ACR 38U-CCID since the ACR 38 is a different
217 reader and is not CCID compatible
218 - allow to select the Power On voltage using Info.plist instead of
219 recompiling the source code
220 - correct bugs in the support of multi-slots readers
221 - if the card is faster than the reader (TA1=97 for example) we try
222 to use a not-so-bad speed (corresponding to TA1=96, 95 or 94)
223 instead of the default speed of TA1=11
224 - the src/parse tool do not use the driver anymore. No need to
225 update the Info.plist file first.
226 - some minor bugs removed
227
228
229 0.9.4 - 27 November 2005, Ludovic Rousseau
230 - add support for Eutron SIM Pocket Combo, Eutron CryptoIdentity,
231 Verisign Secure Token and VeriSign Secure Storage Token, GemPC
232 Card (PCMCIA), SCM SCR331-DI NTTCom, SCM Micro SCR 3310-NTTCom,
233 Cherry ST-1044U, Cherry SmartTerminal ST-2XXX
234 - add support of PC/SC v2 part 10 CM_IOCTL_GET_FEATURE_REQUEST add
235 support of FEATURE_VERIFY_PIN_DIRECT and FEATURE_MODIFY_PIN_DIRECT
236 remove support of IOCTL_SMARTCARD_VENDOR_VERIFY_PIN (now
237 obsoleted). A sample code is available in examples/scardcontrol.c
238 - we need pcsc-lite 1.2.9-beta9 since some structures used for PIN
239 pad readers are defined by pcsc-lite
240 - some (bogus) cards require an extra EGT but the ATR does not say
241 so. We try to detect the bogus cards and set TC1=2
242 - IFDHSetProtocolParameters(): only use a data rate supported by the
243 reader in the PPS negociation, otherwise we stay at the default
244 speed.
245 - calculate and store the read timeout according to the card ATR
246 instead of using a fixed value of 60 seconds
247 - increase the read timeout if the card sends and WTX request
248 - improve support of GemPC Twin and GemPC Card (serial protocol)
249 - reset the device on close only if DRIVER_OPTION_RESET_ON_CLOSE is
250 set. The problem was that a device reset also disconnects the
251 keyboard on a keyboard + reader device.
252 - use color logs
253 - some minor bugs removed
254
255
256 0.9.3 - 14 March 2005, Ludovic Rousseau
257 - change the licence from GNU GPL to GNU Lesser GPL (LGPL)
258 - add support for ACS ACR 38, Kobil KAAN Base, Kobil KAAN Advanced,
259 Kobil KAAN SIM III, Kobil KAAN mIDentity, SCM Micro SCR 331,
260 SCM Micro SCR 331-DI, SCM Micro SCR 335, SCM Micro SCR 3310,
261 SCM Micro SCR 532, Cherry XX44 readers
262 - improve communication speed with readers featuring "Automatic PPS
263 made by the CCID"
264 - switch the Cherry xx33 reader in ISO mode if power up in EMV mode
265 fails.
266 - add support of character level readers. Thanks to O2Micro for the
267 patch
268 - add support for the O2Micro OZ776S reader but the reader firmware
269 is still bogus
270 - check firmware version to avoid firmwares with bugs. You can still
271 use a bogus firmware by setting DRIVER_OPTION_USE_BOGUS_FIRMWARE
272 in Info.plist
273 - some minor bugs removed
274
275 0.9.2 - 15 August 2004, Ludovic Rousseau
276 - T=1 TPDU code:
277 . the work on T=1 TPDU code was possible thanks to Gemplus
278 validation team who helped me test, debug and bring the code to
279 an EMV validation level. Thanks to Jérôme, Jean-Yves, Xavier and
280 the Gemplus readers department
281 . error code was not checked correctly
282 . avoid a (nearly) infinite loop when resynch are needed.
283 . correctly initialise an internal value to allow more than one
284 reader to work
285 - multi-slots readers
286 . add support for multi-slots readers. The only one I have is a
287 SCM Micro SCR 331-DI with a contact and a contactless interface.
288 The contactless interface may or may not work for you since the
289 reader uses proprietary (undocumented) commands.
290 - GemPC Twin serial reader
291 . perform a command (get the reader firmware) to be sure a GemPC
292 Twin (serial or pcmcia) reader is connected
293 . use a dynamic timeout when reading the serial port.
294 The first timeout used when detecting the reader is 2 seconds to
295 not wait too long if no reader is connected. Later timeouts are
296 set to 1 minute to allow long time APDU.
297 - use `pkg-config libpcsclite --cflags` to locate the pcsc-lite
298 header files
299 - use `pkg-config --print-errors --atleast-version=1.2.9-beta5 libpcsclite`
300 to test the pcsc-lite version
301 - code improvements thanks to the splint tool (http://www.splint.org/)
302
303 0.9.1 - 1 July 2004, Ludovic Rousseau
304 - I forgot to define IFD_PARITY_ERROR in a .h file
305
306 0.9.0 - 1 July 2004, Ludovic Rousseau
307 - The T=1 TPDU automata from Carlos Prados' Towitoko driver is very
308 limited and do not support error management mechanisms.
309 I then used the T=1 TPDU automata from OpenCT (OpenSC project).
310 This automata is much more powerful but still lacks a lot of error
311 management code.
312 I then added all the needed code to reach the quality level
313 requested by the EMV standard.
314 - add support for new readers:
315 . Advanced Card Systems ACR 38
316 . Cherry XX33
317 . Dell keyboard SK-3106
318 . Dell smart card reader keyboard
319 . SCR 333
320 - add support of multi procotol cards (T=0 and T=1)
321 - the debug level is now dynamic and set in the Info.plist file (no
322 need to recompile the driver any more)
323 - add support for the libusb naming scheme: usb:%04x/%04x:libusb:%s
324 - INSTALL: add a "configuring the driver for the serial reader
325 (GemPC Twin)" part
326 - use `pkg-config libpcsclite --variable=usbdropdir` so you do not
327 have to use --enable-usbdropdir=DIR or --enable-ccidtwindir=DIR
328 even if pcscd does not use the default /usr/local/pcsc/drivers
329 - add support of IOCTL_SMARTCARD_VENDOR_IFD_EXCHANGE and
330 IOCTL_SMARTCARD_VENDOR_VERIFY_PIN in IFDHControl()
331 - read ifdDriverOptions from Info.plist to limit the use of
332 IOCTL_SMARTCARD_VENDOR_IFD_EXCHANGE (idea from Peter Williams)
333 - provide an example of use of SCardControl()
334 IOCTL_SMARTCARD_VENDOR_IFD_EXCHANGE and
335 IOCTL_SMARTCARD_VENDOR_VERIFY_PIN in example/
336 - add a --enable-pcsclite option (default to yes) so that the driver
337 can be compiled for a different framework (one needing
338 tokenparser.l like Solaris)
339 - Reset action is power off and power on, not just power on
340 - use the include files from pcsc-lite
341 - add a mechanism to allow power on at 1.8V, 3V and then 5V as
342 specified by ISO 7816. We still use 5V for now to avoid problems
343 with non ISO compliant cards
344
345 0.4.1 - 14 February 2004, Ludovic Rousseau
346 - distribute missing files readers/supported_readers.txt and
347 src/create_Info_plist.pl
348 'make install' failed because of this.
349
350 0.4.0 - 13 February 2004, Ludovic Rousseau
351 - support of T=1 with TPDU readers. A lot of the T=1 code comes from
352 Carlos Prados towitoko driver.
353 My code is GNU GPL, his code is GNU LGPL so the global driver is
354 GNU GPL
355 - PPS negotiation if the reader does not do it automatically
356 - add support for the Silitek SK-3105 keyboard. It's a USB device
357 with multiple interfaces
358 - use the create_Info_plist.pl script to generate the installed
359 Info.plist from an Info.plist template and a list of supported
360 readers. The Info.plist was too "complex" to maintain by hand
361 since it now contains 11 entries
362 - add support of IFDHCreateChannelByName to avoid wrong reader
363 enumeration. This is not complete if you have multiple _identical_
364 readers. You need to use a > 1.2.0 pcsc-lite version (not yet
365 released at that time)
366 - build but do not install the serial ccidtwin driver by default
367 since it is useless on computers without a serial port or without
368 this reader for example.
369 - read and write timeouts are not symmetric. write timout can be
370 shorter since the reader and card is not supposed to do anything
371 before receiving (write) a command
372 - do not try to find usb.h and other libusb files if
373 --disable-libusb is used. Needed if you only want to build the
374 serial driver. Thanks to Niki Waibel for the patch
375 - add a --enable-ccidtwindir argument to ./configure to specify the
376 serial GemPC Twin installation directory
377 - debug and code improvements and simplifications
378
379 0.3.2 - 4 November 2003, Ludovic Rousseau
380 - src/commands.c: correct a stupid bug that occurs with an APDU with
381 2 bytes response.
382 - Info.plist: add SPR 532 in list of supported readers
383 - parse.c: do not exit if the InterfaceClass is 0xFF (proprietary).
384 It is the case with old readers manufactured before the final
385 release of the CCID specs.
386 - move LTC31 reader from unsupported to supported reader list. It
387 was my f ault since in used odd INS byte in my test applet and odd
388 INS bytes are forbidden by ISO 7816-4 ch. 5.4.2 Instruction byte.
389 Thanks to Josep Moné s Teixidor for pointing the problem.
390 - src/commands.c: comment out the automatic GET RESPONSE part. I
391 don't think it should be in the driver. Maybe in pcscd instead?
392
393 0.3.1 - 23 September 2003, Ludovic Rouseau
394 - add --enable-multi-thread (enabled by default) for thread safe
395 support an APDU multiplexing. You will need pcsc-lite-1.2.0-rc3 or
396 above to use this feature.
397 - add --enable-libusb=PATH option is your libusb is not installed in
398 /usr or /usr/local
399 - honor DESTDIR in install rules (closes [ #300110 ]). Thanks to
400 Ville Skyttä for the patch.
401 - src/ccid.c: do not switch the GemPC Key and GemPC Twin in APDU
402 mode since it also swicth in EMV mode and may not work with non
403 EMV cards
404 - src/ccid_serial.c: complete reimplementation of the Twin serial
405 protocol using a finite state automata (code much simpler)
406
407 0.3.0 - 10 September 2003, Ludovic Rousseau
408 - support of GemPC Twin connected to a serial port. Thanks to Niki
409 W. Waibel for a working prototype.
410 - support of auto voltage at power up if the reader support it
411 instead of forcing a 5V in all cases.
412 - support of APDU mode instead of just TPDU if the reader support
413 it. Thanks to Jean-Luc Giraud for the idea and inspiration I got
414 from his "concurrent" driver.
415 - support of "time request" from the card.
416 - parse: new indentation for more readability of supported features.
417 - switch the GemPC Key and GemPC Twin in APDU mode since they
418 support it but do not announce it in the dwFeatures.
419 - new build process using autoconf/automake.
420
421 0.2.0 - 26 August 2003, Ludovic Rousseau
422 - Works under MacOS X
423 - Info.plist: use an <array></array> for the alias enumeration
424 - Makefile rework for *BSD and MacOS X
425
426 0.1.0 - 13 August 2003, Ludovic Rousseau
427 - First public release
428
429
430 References:
431 ===========
432
433 [1] http://www.usb.org/developers/devclass_docs/ccid_classspec_1_00a.pdf
434 [2] http://www.gemplus.com/products/gempc433/
435 [3] http://www.gemplus.com/products/gempckey/
436 [4] http://www.gemplus.com/products/gempctwin/
437 [5] http://www.omnikey.com/index.php?id=40
438 [6] http://www.scmmicro.com/security/SCR331.html
439 [7] http://www.scmmicro.com/security/SCR335.html
440 [8] http://www.c3po.es/ltc31.html
441 [9] http://www.scmmicro.com/security/SPR532.html
442 [10] http://www.activcard.com/products/usb_reader.html
443 [11] http://www.scmmicro.com/security/SCR331-DI.html
444 [12] http://www.silitek.com/prod/getProduct.do?xml_id=4_2&menu_id=4_2_8&cid=1_8_5
445 [13] http://www.c3po.es/ltc32.html
446 [14] http://www.c3po.es/tltc2usb.html
447 [15] http://www.scmmicro.com/security/SCR333.html
448 [16] http://www.acs.com.hk/Product_Readers.asp?productID=107&PCate=Products_PC_Linked_SmartCard_Readers
449 [17] http://www.scmmicro.com/support/pcs_product_drivers.html
450 [18] http://www.cherrycorp.com/english/advanced-line/advanced-line_smartboard_g83-6744.htm
451 [19] http://www.kobil.com/e/products/smartcard/kaan-base.php
452 [20] http://www.kobil.com/e/products/smartcard/kaan-advanced.php
453 [21] http://www.kobil.com/d/products/smartcard/kaansim3.php
454 [22] http://www.kobil.com/e/products/index.php?s=midentity
455 [23] http://www.ntt.com/jpki/SCR331DI.html
456 [24] http://www.verisign.co.uk/products-services/security-services/unified-authentication/usb-tokens/
457 [25] http://www.eutron.com/simpocket.asp
458 [26] http://www.cryptoidentity.eutron.com/eng/home.asp
459 [27] http://www.cherry.de/english/advanced-line/advanced_smartterminal_st-1044u.htm
460 [28] http://www.ntt.com/jpki/scr3310.html
461 [29] http://www.asedrive.com/product.asp?pid=1
462 [30] http://www.scmmicro.com/security/SCR3310.html
463 [31] http://scmmicro.com/security/SCR3311.html
464 [31] http://scmmicro.com/security/SCR3320.html
465 [32] http://www.smartepad.com.br/
466 [33] http://www.omnikey.com/index.php?id=121
467 [34] http://www.scmmicro.com/security/SCR3340.html
468 [35] http://www.cherry.de/deutsch/advanced-line/advanced_smart_terminal_st-2000u.htm
469 [36] http://www.omnikey.com/index.php?id=21
470 [37] http://www.omnikey.com/index.php?id=114
471 [38] http://www.reflexreaders.com/Products/reflex_usbnew.html
472 [39] http://www.scmmicro.com/security/SDI_010.html
473 [40] http://www.winbond.com.tw/E-WINBONDHTM/partner/b_2_e_4.htm
474 [41] http://www.gemplus.com/products/gempc_card/
475 [42] http://www.asedrive.com/product.asp?pid=2
476 [43] http://www.omnikey.com/index.php?id=50
477 [44] http://h18000.www1.hp.com/products/quickspecs/12346_na/12346_na.HTML
478 [45] http://www.id3semiconductors.com/produits/cl1356D.htm
479 [46] http://www.alcormicro.com/products_detail.php?main_id=8&p_id=21
480 [47] http://www.tai-hao.com/english/products_detail.php?main_id=4&second_id=13&p_id=53&now_rows=1
481
482 $Id$
483
484 vim:ts=20

Properties

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

  ViewVC Help
Powered by ViewVC 1.1.5