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

Contents of /trunk/Drivers/ccid/README

Parent Directory Parent Directory | Revision Log Revision Log


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

Properties

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

  ViewVC Help
Powered by ViewVC 1.1.5