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