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

Contents of /trunk/Drivers/ccid/README

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1018 - (hide annotations) (download)
Thu Jul 1 11:38:03 2004 UTC (8 years, 11 months ago) by rousseau
File size: 11765 byte(s)
release 0.9.1
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 969 - Cherry XX33 keyboard [?]
24     - Dell keyboard SK-3106 [?]
25     - Dell smart card reader keyboard [?]
26 rousseau 273 - Gemplus GemPC 433 SL [2]
27     - Gemplus GemPC Key [3]
28     - Gemplus GemPC Twin [4]
29     - OmniKey CardMan 3121 [5]
30 rousseau 606
31    
32     Should work but untested by me:
33     ===============================
34    
35     I would like to get these readers to perform test and validation and
36     move them in the supported list above. If you are one of the
37     manufacturers, please, contact me.
38    
39 rousseau 708 - ActivCard USB reader 2.0 [10]
40 rousseau 709 - C3PO LTC32 [13]
41 rousseau 666 - SCM Micro SCR 331-DI [11]
42 rousseau 709 - SCM Micro SCR 333 [15]
43     - Silitek SK-3105 keyboard [12] or C3PO TLTC2USB [14]
44 rousseau 269
45    
46 rousseau 969 Unsupported or partly supported CCID readers:
47     =============================================
48 rousseau 269
49 rousseau 969 - Advanced Card Systems ACR 38 [16] (see Known problems n°1)
50     - C3PO LTC31 [8] (see Known problems n°2)
51     - SCM Micro SCR 335 [7] (see Known problems n°1)
52     - SCM Micro SCR 331 [6] (see Known problems n°1)
53     - SCM Micro SPR 532 [9] (see Known problems n°1)
54 rousseau 269
55    
56 rousseau 321 Supported operating systems:
57     ============================
58    
59     - GNU/Linux (libusb 0.1.7)
60     - MacOS X/Darwin (libusb 0.1.8beta, CVS snapshot. See "Known problems")
61     to libusb)
62    
63    
64 rousseau 862 Debug informations:
65     ===================
66    
67     The driver uses the debug function provided by pcscd. So if pcscd sends
68     its debug to stdout (pcscd --foreground) then the CCID will also send
69     its debug to stdout. If pcscd sends its debug to syslog (by default)
70     then the CCID will also send its debug to syslog.
71    
72     You can change the debug level using the Info.plist configuraion file.
73     The Info.plist is installed, by default, in
74     /usr/local/pcsc/drivers/ifd-ccid.bundle/Contents/Info.plist
75    
76     The debug level is set in the ifdLogLevel field. It is a binary OR
77     combinaison of 4 different levels.
78     - 1: critical: important error messages
79     - 2: info: informative messages like what reader was detected
80     - 4: periodic: periodic info when pcscd test if a card is present (every
81     1/10 of a second)
82     - 8: comm: a dump of all the bytes exchanged between the host and the
83     reader
84    
85     By default the debug level is set to 3 (1 + 2) and correspond to the
86     critical and info levels.
87    
88     You have to restart the driver so it read the configuration file again
89     and use the new debug level value. To restart the driver you just need
90     to unplug all your CCID readers so the the driver is unloaded and then
91     replug your readers. You can also restart pcscd.
92    
93    
94 rousseau 321 Known problems:
95     ===============
96    
97 rousseau 969 1. USB timeout
98     """"""""""""""
99     Some readers do timeout when a special USB frame is sent from the
100     reader. If the frame size if a multiple of wMaxPacketSize the
101     communication is stopped. You should contact the reader vendor to
102     upgrade the firmware of the reader or replace the reader.
103 rousseau 321
104 rousseau 969 2. Kernel 2.6
105     """""""""""""
106     The reader works fine with Linux kernel 2.4 but does not with Linux
107     kernel 2.6. The ioctl() syscall returns EINVAL (Invalid argument)
108 rousseau 340
109 rousseau 969 3. MacOSX libusb
110     """"""""""""""""
111     There is a bug in libusb that crash the libusb library when you
112     unplug a reader and replug it in another USB socket. So if you
113     unplug a reader replug it in the same USB socket.
114    
115     see http://sourceforge.net/tracker/index.php?func=detail&aid=886778&group_id=1674&atid=101674
116    
117    
118 rousseau 273 Licence:
119     ========
120    
121 rousseau 269 This program is free software; you can redistribute it and/or modify
122     it under the terms of the GNU General Public License as published by the
123     Free Software Foundation; either version 2 of the License, or (at your
124     option) any later version.
125    
126     This program is distributed in the hope that it will be useful, but
127     WITHOUT ANY WARRANTY; without even the implied warranty of
128     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
129     General Public License for more details.
130    
131     You should have received a copy of the GNU General Public License
132     along with this program; if not, write to the Free Software Foundation,
133     Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
134    
135    
136     History:
137     ========
138    
139 rousseau 1018 0.9.1 - 1 July 2004, Ludovic Rousseau
140     - I forgot to define IFD_PARITY_ERROR in a .h file
141    
142 rousseau 1015 0.9.0 - 1 July 2004, Ludovic Rousseau
143     - The T=1 TPDU automata from Carlos Prados' Towitoko driver is very
144     limited and do not support error management mechanisms.
145     I then used the T=1 TPDU automata from OpenCT (OpenSC project).
146     This automata is much more powerful but still lacks a lot of error
147     management code.
148     I then added all the needed code to reach the quality level
149     requested by the EMV standard.
150     - add support for new readers:
151     . Advanced Card Systems ACR 38
152     . Cherry XX33
153     . Dell keyboard SK-3106
154     . Dell smart card reader keyboard
155     . SCR 333
156     - add support of multi procotol cards (T=0 and T=1)
157     - the debug level is now dynamic and set in the Info.plist file (no
158     need to recompile the driver any more)
159     - add support for the libusb naming scheme: usb:%04x/%04x:libusb:%s
160     - INSTALL: add a "configuring the driver for the serial reader
161     (GemPC Twin)" part
162     - use `pkg-config libpcsclite --variable=usbdropdir` so you do not
163     have to use --enable-usbdropdir=DIR or --enable-ccidtwindir=DIR
164     even if pcscd does not use the default /usr/local/pcsc/drivers
165     - add support of IOCTL_SMARTCARD_VENDOR_IFD_EXCHANGE and
166     IOCTL_SMARTCARD_VENDOR_VERIFY_PIN in IFDHControl()
167     - read ifdDriverOptions from Info.plist to limit the use of
168     IOCTL_SMARTCARD_VENDOR_IFD_EXCHANGE (idea from Peter Williams)
169     - provide an example of use of SCardControl()
170     IOCTL_SMARTCARD_VENDOR_IFD_EXCHANGE and
171     IOCTL_SMARTCARD_VENDOR_VERIFY_PIN in example/
172     - add a --enable-pcsclite option (default to yes) so that the driver
173     can be compiled for a different framework (one needing
174     tokenparser.l like Solaris)
175     - Reset action is power off and power on, not just power on
176     - use the include files from pcsc-lite
177     - add a mechanism to allow power on at 1.8V, 3V and then 5V as
178     specified by ISO 7816. We still use 5V for now to avoid problems
179     with non ISO compliant cards
180    
181    
182 rousseau 703 0.4.1 - 14 February 2004, Ludovic Rousseau
183     - distribute missing files readers/supported_readers.txt and
184     src/create_Info_plist.pl
185     'make install' failed because of this.
186    
187 rousseau 697 0.4.0 - 13 February 2004, Ludovic Rousseau
188     - support of T=1 with TPDU readers. A lot of the T=1 code comes from
189     Carlos Prados towitoko driver.
190     My code is GNU GPL, his code is GNU LGPL so the global driver is
191     GNU GPL
192     - PPS negotiation if the reader does not do it automatically
193     - add support for the Silitek SK-3105 keyboard. It's a USB device
194     with multiple interfaces
195     - use the create_Info_plist.pl script to generate the installed
196     Info.plist from an Info.plist template and a list of supported
197     readers. The Info.plist was too "complex" to maintain by hand
198     since it now contains 11 entries
199     - add support of IFDHCreateChannelByName to avoid wrong reader
200     enumeration. This is not complete if you have multiple _identical_
201     readers. You need to use a > 1.2.0 pcsc-lite version (not yet
202     released at that time)
203     - build but do not install the serial ccidtwin driver by default
204     since it is useless on computers without a serial port or without
205     this reader for example.
206     - read and write timeouts are not symmetric. write timout can be
207     shorter since the reader and card is not supposed to do anything
208     before receiving (write) a command
209     - do not try to find usb.h and other libusb files if
210     --disable-libusb is used. Needed if you only want to build the
211     serial driver. Thanks to Niki Waibel for the patch
212     - add a --enable-ccidtwindir argument to ./configure to specify the
213     serial GemPC Twin installation directory
214     - debug and code improvements and simplifications
215    
216 rousseau 552 0.3.2 - 4 November 2003, Ludovic Rousseau
217     - src/commands.c: correct a stupid bug that occurs with an APDU with
218     2 bytes response.
219     - Info.plist: add SPR 532 in list of supported readers
220     - parse.c: do not exit if the InterfaceClass is 0xFF (proprietary).
221     It is the case with old readers manufactured before the final
222     release of the CCID specs.
223     - move LTC31 reader from unsupported to supported reader list. It
224     was my f ault since in used odd INS byte in my test applet and odd
225     INS bytes are forbidden by ISO 7816-4 ch. 5.4.2 Instruction byte.
226     Thanks to Josep Moné s Teixidor for pointing the problem.
227     - src/commands.c: comment out the automatic GET RESPONSE part. I
228     don't think it should be in the driver. Maybe in pcscd instead?
229    
230 rousseau 467 0.3.1 - 23 September 2003, Ludovic Rouseau
231     - add --enable-multi-thread (enabled by default) for thread safe
232     support an APDU multiplexing. You will need pcsc-lite-1.2.0-rc3 or
233     above to use this feature.
234     - add --enable-libusb=PATH option is your libusb is not installed in
235     /usr or /usr/local
236     - honor DESTDIR in install rules (closes [ #300110 ]). Thanks to
237     Ville Skyttä for the patch.
238     - src/ccid.c: do not switch the GemPC Key and GemPC Twin in APDU
239     mode since it also swicth in EMV mode and may not work with non
240     EMV cards
241     - src/ccid_serial.c: complete reimplementation of the Twin serial
242     protocol using a finite state automata (code much simpler)
243    
244 rousseau 423 0.3.0 - 10 September 2003, Ludovic Rousseau
245     - support of GemPC Twin connected to a serial port. Thanks to Niki
246     W. Waibel for a working prototype.
247     - support of auto voltage at power up if the reader support it
248     instead of forcing a 5V in all cases.
249     - support of APDU mode instead of just TPDU if the reader support
250     it. Thanks to Jean-Luc Giraud for the idea and inspiration I got
251     from his "concurrent" driver.
252 rousseau 425 - support of "time request" from the card.
253 rousseau 423 - parse: new indentation for more readability of supported features.
254     - switch the GemPC Key and GemPC Twin in APDU mode since they
255     support it but do not announce it in the dwFeatures.
256     - new build process using autoconf/automake.
257    
258 rousseau 342 0.2.0 - 26 August 2003, Ludovic Rousseau
259     - Works under MacOS X
260     - Info.plist: use an <array></array> for the alias enumeration
261     - Makefile rework for *BSD and MacOS X
262    
263 rousseau 273 0.1.0 - 13 August 2003, Ludovic Rousseau
264     - First public release
265 rousseau 269
266    
267 rousseau 425 Bibliography:
268     =============
269 rousseau 269
270     [1] http://www.usb.org/developers/devclass_docs/ccid_classspec_1_00a.pdf
271 rousseau 273 [2] http://www.gemplus.com/products/gempc433/
272     [3] http://www.gemplus.com/products/gempckey/
273 rousseau 269 [4] http://www.gemplus.com/products/gempctwin/
274 rousseau 273 [5] http://www.omnikey.com/en/produkt_details.php3?produkt=1&variante=47
275     [6] http://www.scmmicro.com/security/SCR331.html
276     [7] http://www.scmmicro.com/security/SCR335.html
277 rousseau 709 [8] http://www.c3po.es/ltc31.html
278 rousseau 553 [9] http://www.scmmicro.com/security/SPR532.html
279 rousseau 606 [10] http://www.activcard.com/products/usb_reader.html
280 rousseau 666 [11] http://www.scmmicro.com/security/SCR331-DI.html
281 rousseau 677 [12] http://www.silitek.com/prod/getProduct.do?xml_id=4_2&menu_id=4_2_8&cid=1_8_5
282 rousseau 709 [13] http://www.c3po.es/ltc32.html
283     [14] http://www.c3po.es/tltc2usb.html
284     [15] http://www.scmmicro.com/security/SCR333.html
285 rousseau 969 [16] http://www.acs.com.hk/products_readers_acr38.asp
286 rousseau 269
287     $Id$
288    
289     vim:ts=20

Properties

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

  ViewVC Help
Powered by ViewVC 1.1.5