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

Contents of /trunk/Drivers/ccid/README

Parent Directory Parent Directory | Revision Log Revision Log


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

Properties

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

  ViewVC Help
Powered by ViewVC 1.1.5