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

Contents of /trunk/Drivers/ccid/README

Parent Directory Parent Directory | Revision Log Revision Log


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

Properties

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

  ViewVC Help
Powered by ViewVC 1.1.5