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

Contents of /trunk/Drivers/ccid/README

Parent Directory Parent Directory | Revision Log Revision Log


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

Properties

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

  ViewVC Help
Powered by ViewVC 1.1.5