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

Contents of /trunk/Drivers/ccid/README

Parent Directory Parent Directory | Revision Log Revision Log


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

Properties

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

  ViewVC Help
Powered by ViewVC 1.1.5